Question

我想生成某些参数的文档，这些参数是我程序中各种类的Save-Method生成的。为此，我想在我的保存方法的顶部写一条评论，这些评论应该转到html和PDF文件。

我想使用doxygen来解析我的C ++项目的源文件和头文件，但是默认情况下，doxygen会为我项目中的所有成员和类生成一个文档，这不是我真正想要的。

是否可以自定义doxygen来生成只有一个方法的文档，这个方法总是具有相同的签名和名称（int Save（）;），而没有别的？怎么能实现呢？

Answer 1

您是否查看了ENABLED_SECTIONS和cond命令？以下是该示例的片段：

/// @cond DEV
/*
 *  The implementation of the interface
 */
class Implementation : public Intf
{
  public:
    void func();

    /// @cond TEST
    void test();
    /// @endcond

    /// @cond
    /** This method is obsolete and does
     *  not show up in the documentation.
     */
    void obsolete();
    /// @endcond
};

/// @endcond

根据ENABLED_SECTIONS是否包含TEST或DEV，输出会有所不同。

如果这没有帮助，请澄清您的问题。

如何让Doxygen仅为具有注释

1 个答案: