如何创建仅在Doxygen中记录“公共”API的文件

Question

我有一个我正在处理的项目是库。我需要为了我自己的目的记录库代码的内部，但还需要向我的用户提供有关如何使用库的API文档。

因此，在我希望提供给他们的文档中，我想只包括“公共”函数，结构，变量等 - 而不 内部的。

我有办法在Doxygen中做到这一点吗？我可以描述什么是“公共”，什么是“私人”？我是否可以为我的用户生成一个仅包含“公共”API的文档，以及另一个包含我自己使用的“私有”设计详细信息的文档？

注意：这是直接的C，而不是C ++ - 我对“公共”和“私人”这两个术语的使用与“公共”和“私人”类成员无关。

Answer 1

根据您的需要，有以下几种方法：

• 您可以使用\internal代码
• 您可以在doxyfile
中使用\private标记和EXTRACT_PRIVATE=NO
• 以及可能涉及各种EXTRACT_配置变量之一的其他人。