如何doxygen评论Qt属性？

Question

我想将Doxygen评论附加到我的Q_PROPERTYs.

例如:

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()是存取函数？我想实现一个类似的输出来此.

Answer 1

doxygen支持开箱即用的Qt属性.只需在属性声明上方添加文档注释,您就会在doxygen输出中看到"属性".

请注意,访问者功能将单独记录,如果他们也有文档注释.因此,如果要在生成的文档中取消这些注释,则需要从这些访问器函数中删除文档注释.

Answer 2

我终于找到了办法做到这一点.

• 在源文件中:

  /**
   * @brief The name of the user.
   * @accessors name(), setName()
   */
  Q_PROPERTY(QString name READ name WRITE setName)
  

• 在Doxyfile:

  ALIASES = "accessors=\par Accessors:\n"
  

我所做的是定义一个名为"accessors" 的别名,它将生成一个标题为"Accessors:"的段落,后跟引用的方法.

这是文档中的样子:

提示:如果属性的名称与读取属性的方法相同,您可能希望在文档中的访问者名称前面加上' %'(否则访问者将显示为指向自身的链接):

/**
 * ...
 * @accessors %name(), setName()
 * ...
 */