c++ - 如何doxygen注释Qt属性？

Question

我想将 Doxygen 评论附加到我的 Q_PROPERTY。

例如:

歌曲.h

class Song : public QObject
{
    Q_OBJECT

private:
    Q_PROPERTY(QString title READ title WRITE setTitle);
    QString _title;

public:
    QString title() const;
    void setTitle(const QString& value);
};

歌曲.cpp

#include "song.h"

Song::Song(QObject *parent) :
    QObject(parent)
{
}

QString Song::title() const { return _title; }

void Song::setTitle(const QString &value) { _title = value; }

我如何告诉 Doxygen title 是 Qt 元对象系统中的一个属性，而 title() 和 setTitle() 是访问函数？我想实现与 this 类似的输出.

Answer 1

doxygen 开箱即用地支持 Qt 属性。只需在属性声明上方添加文档注释，您就会在 doxygen 输出中看到一个“属性”。

请注意，访问器函数将单独记录，如果它们也有文档注释的话。因此，如果您想在生成的文档中抑制这些内容，则需要从这些访问器函数中删除文档注释。