documentation - 如何在 Doxygen 中创建仅记录 "Public"API 的文件

Question

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

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

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

注意:这是直接的 C，而不是 C++——我对术语“公共(public)”和“私有(private)”的使用与“公共(public)”和“私有(private)”类成员无关。

Answer 1

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

您可以使用 \internal 标签

您可以使用 \private 与 EXTRACT_PRIVATE=NO 一起标记在 doxyfile

可能还有其他涉及各种 EXTRACT_ 之一的配置变量。