c++ - Doxygen 私有(private)函数

Question

有没有办法让 doxygen 显示各个私有(private)函数的文档？我希望 doxygen 不显示绝大多数私有(private)函数的文档，而是显示少数私有(private)函数的文档。我的动机是这些 C++ 私有(private)函数作为扩展提供给 Python，我希望它们的文档显示在 Doxygen 中。但是，我不希望它们公开，因为只有类(class)本身才需要它们；他们绝对属于私营部门。

谢谢

Answer 1

我在配置文件中设置了以下内容:

EXTRACT_PRIVATE = YES

HIDE_UNDOC_MEMBERS = YES

这具有预期的效果，但仍会显示所有已记录私有(private)成员的文档。

然后我使用 @internal 作为我不想显示的私有(private)成员文档的第一行。

此外，我仍然可以使用普通的 C++ 注释来记录私有(private)成员。 IE。不要使用 /** ... */ 使用 /* ... */。 通常我对成员变量使用普通注释。

最后，如果我真的想显示我可以设置的所有私有(private)文档:

INTERNAL_DOCS = YES

创建更广泛的文档版本。