Doxygen私人功能

Question

有没有办法让doxygen显示个人私人功能的文档？我希望doxygen不显示绝大多数私有函数的文档,但是为少数私有函数显示它.我的动机是这些C++私有函数作为扩展提供给Python,我希望他们的文档显示在Doxygen中.但是,我不希望它们被公开,因为它们只是课程本身所需要的; 他们绝对属于私营部门.

谢谢

Answer 1

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

EXTRACT_PRIVATE = YES

HIDE_UNDOC_MEMBERS = YES

这达到了预期的效果，但仍会显示所有有记录的私人成员的文档。

然后，我将@internal其用作我不想显示的私人成员文档的第一行。

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

最后，如果我真的想显示所有我可以设置的私人文档：

INTERNAL_DOCS = YES

创建更广泛的文档版本。

Answer 2

有几种方法可以实现这一目标。

您可以简单地不记录那些您不希望可见的功能。默认情况下，Doxygen 不会显示您未记录的任何成员。因此，您可以只告诉它显示私人成员，并且不会显示任何未记录的私人成员。