Doxygen私有函数

Question

有没有办法让doxygen显示各个私有函数的文档？我希望doxygen不显示绝大多数私有函数的文档，而是显示一些特定私有函数的文档。我的动机是，这些C++私有函数是作为扩展提供给Python的，我希望它们的文档能够在Doxygen中显示出来。但是，我不希望它们是公共的，因为它们只由类本身需要；它们肯定属于私有部门。

谢谢

Answer 1

可以通过将其部分标签添加到ENABLED_SECTIONS配置选项来包括\cond和\endcond命令之间的部分。如果省略了节标签，则该节将被无条件排除在处理范围之外。

/** An interface */
class Intf
{
  public:
    /** A method */
    virtual void func() = 0;

    /// @cond COND1

    /** A method used for testing */
    virtual void test() = 0;

    /// @endcond
};

请参阅cond help

不显示COND1部分:只是不要将其添加到ENABLED_SECTIONS配置选项中。

Answer 2

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

EXTRACT_PRIVATE = YES

HIDE_UNDOC_MEMBERS = YES

这具有预期的效果，但仍将显示所有有文档记录的私有成员的文档。

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

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

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

INTERNAL_DOCS = YES

来创建一个更具扩展性的文档版本。

Answer 3

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

你可以简单地不记录那些你不想看到的函数。默认情况下，Doxygen不会显示您未记录的任何成员。因此，您只需告诉它显示私有，任何未记录的私有成员都不会显示。