doxygen添加枚举在生成的文档里面显示

简 述： 类里面有着枚举；想要在生成的文件html文件可以直接预览

[TOC]

本文初发于 “偕臧的小站” ifmet.cn，同步转载于此。

同步博文：

• 本篇的csdn/github.io同步博文:  doxygen添加枚举在生成的文档里面显示

在类里面有枚举数值, 但是需要在生成html里面显示出来; 其中类里面的枚举如下:

class DFloatingMessage : public DFloatingWidget
{
...
public:
    enum MessageType {
        TransientType,  //临时的消息
        ResidentType    //常驻的消息
        };
...
}

在对应的项目工程中, 可以写下如下的注释代码:

/*!
 *
 * \~chinese \enum DFloatingMessage::MessageType
 * \~chinese DFloatingMessage::MessageType 定义了 DFloatingMessage 通知类型
 * \~chinese \var DFloatingMessage:MessageType DFloatingMessage::TransientType
 * \~chinese 临时的消息
 * \~chinese \var DDFloatingMessage:MessageType DFloatingMessage::ResidentType
 * \~chinese 常驻的消息
 */

生成的效果图如下:

I don't rely on this for a living, but I would be encouraged if you donated.

• 本文作者：偕臧
• 本文链接：https://ifmet.cn/posts/53427761/
• 版权声明：本博客所有文章除特别声明外，均默认采用 许可协议。