如何在Doxygen中创建一个仅包含“公共”API文件的文件

Question

我有一个项目，我正在研究这是一个库。为了我自己的目的，我需要记录库代码的内部结构，但也需要向我的用户提供API文档，以了解它们应该如何使用库。

所以，我想给他们的文件，我想只包括“公共”的功能，结构，变量，等等 - 而不是的内部那些。

有没有一种方法可以在Doxygen中做到这一点？我可以描述什么是“公共”，什么是“私人”？我可以为我的用户生成仅包含“公共”API的文档，还可以为我自己使用包含“私人”设计细节的单独文档？

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

Answer 1

根据您的需要，也有这样做的几种方法：

• 您可以使用\internal标签
• 您可以的Doxyfile与EXTRACT_PRIVATE=NO一起使用\private标签
• 和可能其他人参与各种EXTRACT_配置变量之一。