有关控制Doxygen枚举文档的问题

时间:2020-01-15 16:25:35

标签: doxygen

我正在使用Doxygen来记录C ++库。枚举文档几乎没有帮助,我找不到任何有关控制输出的信息。生成的输出将未记录版本的枚举放在“枚举”部分的名称空间页面顶部,“枚举类型文档”部分下的各个元素链接到实际有用的文档。在一个真实的示例中,在页面进入“枚举类型文档”部分之前,可能有许多未记录的枚举,在此处可以找到记录每个值的用法的有用帮助。

如何在保留实际记录枚举值的“枚举类型文档”部分的同时完全取消“枚举”部分?

Example documentation output

输出是从此示例.h文件生成的:

//! \file
#pragma once

//! \brief My main namespace
namespace MyNamespace
{
    //! \brief An example enumeration with the useful values documented.
    enum class MyExampleEnum
    {
        UNKNOWN,

        FirstValue,     //!< This is the useful documentation
        SecondValue,    //!< This is useful documentation of SecondValue

        COUNT,
    };
}

0 个答案:

没有答案