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

Question

我有一个正在开发的项目，它是一个库。我需要为自己的目的记录库代码的内部结构，但还需要向我的用户提供关于他们应该如何使用库的 API 文档。

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

有没有办法在 Doxygen 中做到这一点？我可以区分什么是“公共”和什么是“私人”吗？我可以为我的用户生成一个只包含“公共”API 的文档，以及一个包含“私有”设计细节的单独文档供我自己使用吗？

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

Answer 1

根据您的需要，有几种方法可以做到这一点：

• 你可以使用\internal标签
• 您可以在 doxyfile 中将\private 标签与EXTRACT_PRIVATE=NO 一起使用
• 可能还有其他涉及各种EXTRACT_ 配置变量之一。