我想把Doxygen的评论附加到我的Q_PROPERTY中.
例如：
song.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);
};
song.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标题是Qt元对象系统中的属性,而title()和setTitle()是访问器函数？我想要实现类似的输出到this.
解决方法
我终于找到了一个办法来做到这一点.
>在源文件中：
/** * @brief The name of the user. * @accessors name(),setName() */ Q_PROPERTY(QString name READ name WRITE setName)
>在Doxyfile中：
ALIASES = "accessors=\par Accessors:\n"
我所做的是定义名为“accessors”的an alias,它将生成一个标题为“Accessors：”的段落,后跟引用的方法.
以下是文档中的内容：
提示：如果属性的名称与读取属性的方法相同,则可能需要在文档中的访问者姓名之前加上“％”(否则访问者将显示为指向自身的链接) ：
/** * ... * @accessors %name(),setName() * ... */
