Question

我正在编写文档哦这段代码：

    namespace A {

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

}

结果，ENUM的注释值不显示。

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

Answer 1

您必须使用以下格式：

    namespace A {
            /*!
            *  \addtogroup A
            *  @{
            */

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

            /*! @} */

    }

Answer 2

您要将enum文档标题放在发布位置，它应该位于enum定义的正上方：

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

Answer 3

这是一篇很老的帖子，但对于像我这样的人来说，在命名空间下努力学习全局枚举，函数等是没有\addtogroup的简单解决方案

确保为命名空间添加说明。有了这个，甚至自动链接也能完美无缺。

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

对于嵌套命名空间，您应该为包含其他变量，枚举，函数等的命名空间添加描述。

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

中测试

命名空间中的Doxygen枚举

3 个答案: