主页 / coding / 问题 / 79421573
Accepted
cancech
Asked: 2025-02-08 00:32:06 +0800 CST

如果存在 Q_OBJECT，则 Doxygen 更新类详细描述

  • 772

假设我有以下课程

/**
 * @brief Brief description
 *
 * Longer description
 */
class MyClass: public QObject {

    Q_OBJECT

public:
    /**
     * @brief CTOR
     */
    MyClass() = default;

    /**
     * @brief DTOR
     */
    virtual ~MyClass() = default;

   // Etcetera
};

当我去生成 Doxygen 文档时，会生成相应的文档，但是Q_OBJECT默认情况下它会忽略。我想要实现的是在生成的文档中向类添加某种指示，以表明该类支持Qt Signals and Slots。我可以使用该PREDEFINED属性让 Doxygen 用其他东西替换该宏

PREDEFINED = "Q_OBJECT=/// @note Supports Signals and Slots"

然而，这会应用于下一个后续元素（本例中为构造函数），而不是类本身。在我挖掘的过程中，我遇到了<运算符，但它似乎只适用于字段和参数，而不适用于类。

是否有某种方法可以在类文档中获得某种指示/标记来表明Q_OBJECT存在并且信号和槽将受到支持，而不依赖于手动将这样的标记添加到类注释中？

注意：我使用的是 Doxygen 版本 1.11.0

qt

1 个回答

  1. Best Answer

    当我使用以下设置时：

    QUIET = YES
MACRO_EXPANSION = YES
PREDEFINED = "QObject=QObject /** @note Supports Signals and Slots */"
PREDEFINED += "Q_OBJECT="

    我得到的结果是： 在此处输入图片描述

    （注：当前 doxygen 版本是 1.13.2）

    • 2

相关问题