命名空间中的doxygen枚举

Doxygen enum in namespace

本文关键字：枚举 doxygen 命名空间      更新时间：2023-10-16

我正在编写文档哦，此代码：

    namespace A {
    enum ENUM 
    {
        /// var step to frame
        ENUM_1  = 0,            //!< val1
        ENUM_1  = 1,            //!< val2
        ENUM_2 = 2          //!< val3
    };
}

结果，未显示枚举的注释值。

当我删除命名空间时，一切都很好，但是现在没有

您必须使用此格式：

    namespace A {
            /*!
            *  addtogroup A
            *  @{
            */
            /// step to frame
            enum ENUM 
            {
                    ENUM_1  = 0,            //!< val1
                    ENUM_1  = 1,            //!< val2
                    ENUM_2 = 2          //!< val3
            };
            /*! @} */
    }

您将enum文档标头放在来自位置，它应直接在enum定义上方：

/// brief Step to frame
enum ENUM
{
    ...
};

这是一个旧帖子，但对于像我这样挣扎着全局枚举，功能等的人。在这个名称空间下，这是一个简单的解决方案，没有addtogroup

只需确保您为命名空间添加描述即可。这样，即使是自动链接的作品也完美无缺。

/// this the namespace A
namespace A {
    /// step to frame
    enum ENUM 
    {
        ENUM_1 = 0,         //!< val1
        ENUM_1 = 1,         //!< val2
        ENUM_2 = 2          //!< val3
    };
}

对于嵌套命名空间，您应该为包含其他VAR，枚举，功能等的名称空间描述。

namespace A {
  /// this the namespace A::B
  namespace B {
    /// step to frame 
    enum ENUM 
    {
        ENUM_1 = 0,         //!< val1
        ENUM_1 = 1,         //!< val2
        ENUM_2 = 2          //!< val3
    };
  }
}

在 1.8.7

中测试的方式
相关文章：