首页 > 解决方案 > 关于控制 Doxygen 中的枚举文档的问题

问题描述

我正在使用 Doxygen 来记录 C++ 库。枚举的文档几乎没有它可能的帮助,而且我找不到任何关于控制输出的信息。生成的输出将未记录版本的枚举放在命名空间页面顶部的“枚举”部分中,其中的各个元素链接到实际有用的文档,位于枚举类型文档部分下。在一个真实的例子中,在页面到达 Enumeration Type Documentation 部分之前,可能有许多这些未记录的枚举,在该部分可以找到记录每个值的使用的有用帮助。

如何完全禁止枚举部分,同时保留实际记录枚举值的枚举类型文档部分?

示例文档输出

输出是从此示例 .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,
    };
}

标签: doxygen

解决方案


推荐阅读