Doxygen私人功能 [英] Doxygen private function

问题描述

有办法让doxygen显示个别私人功能的文件吗？我想doxygen不显示绝大多数私人功能的文档，但显示它的一些选择的私人功能。我的动机是，这些C ++私人函数提供给Python作为扩展，我想要他们的文档显示在Doxygen。然而，我不想让他们公开，因为他们只需要课堂自己;

感谢

解决方案

可以通过将其段标签添加到ENABLED_SECTIONS配置选项来包含\cond和\endcond命令之间的部分。

  / **接口* / 
类Intf 
 {
 public：
 / **方法* / 
 virtual void func（）= 0; 
 
 /// @cond COND1 
 
 / **用于测试的方法* / 
 virtual void test（）= 0; 
 
 /// @endcond 
}; 
  

请参阅 cond help

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

Is there a way to have doxygen show the documentation for individual private functions? I want doxygen to not show the documentation for the vast majority of private functions but show it for a select few private functions. My motivation is that these C++ private functions are provided to Python as extensions and I want their documentation to show up in Doxygen. However, I don't want them to be public because they are only needed by the classes themselves; they definitely belong in the private sector.

Thanks

解决方案

The section between \cond and \endcond commands can be included by adding its section label to the ENABLED_SECTIONS configuration option. If the section label is omitted, the section will be excluded from processing unconditionally.

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

    /// @cond COND1

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

    /// @endcond
};

See cond help

Not to see COND1 sections: just do not add it to ENABLED_SECTIONS configuration option.

这篇关于Doxygen私人功能的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！