c++ - Doxygen 私有函数

Question

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

谢谢

Answer 1

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

EXTRACT_PRIVATE = YES

HIDE_UNDOC_MEMBERS = YES

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

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

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

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

INTERNAL_DOCS = YES

创建更广泛的文档版本。

Answer 2

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

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

    /// @cond COND1

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

    /// @endcond
};

查看条件帮助

看不到 COND1 部分：只是不要将其添加到 ENABLED_SECTIONS 配置选项中。

Answer 3

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

你可以简单地不记录那些你不想看到的功能。默认情况下，Doxygen 不会显示您没有记录的任何成员。因此，您可以告诉它显示私人信息，并且不会显示任何未记录的私人成员。