如何记录与Q_PROPERTY同名的访问者功能？

Question

TL; DR:如何为与其声明的属性同名的访问者生成doxygen文档Q_PROPERTY？

---

Qt的属性系统可以在给定属性上使用Qt的元对象系统:

// example class and documentation
class Widget : public QObject {
  Q_OBJECT
  Q_PROPERTY(int size READ size WRITE setSize NOTIFY sizeChanged)

public:
  Widget(QObject * parent = nullptr) : QObject(parent){}
  int size() const;

public slots:
  void setSize(int new_size);

signals:
  void sizeChanged(int); //!< signals a size change

private:
  int m_size = 0; //!< the Widget's size, see #size.
};

如果现在在实现中使用doxygen

//! @property size is the size of our widget

//! @brief Set the widget's size to @a new_size.
void Widget::setSize(int new_size) { 
  if(new_size != m_size) {
    m_size = new_size; 
    emit sizeChanged(m_size);
  }
}

//! @brief Returns the widget's size.
int Widget::size() const {
  return m_size;
}

只有setSize正确生成的文件.size()的文件被误认为是该物业的文件.上面的代码就像是一样

//! @property size
//! @brief Returns the widget's size.
int Widget::size() const {
  return m_size;
}

被使用了.也@fn Widget::size()const没有任何其他doxygen特殊命令似乎有帮助:size()生成的文档保持为空并最终在size(属性)文档中.

这是一个错误,还是我错过了什么？

Answer 1

这是一个已知的错误或相当未实现的功能.截至今天,如果属性和吸气剂具有相同的名称,则无法对其进行记录.getter的文档总是会出现在属性的文档中.

这样做的原因是doxygen的findmember实现.如果你使用,doxygen -d findmembers你可以看到size(属性)和size()(函数)"匹配":

findMemberDocumentation(): root->type=`int' root->inside=`' root->name=`Widget::size' root->args=`() const ' section=6000000 root->spec=0 root->mGrpId=-1
findMember(root=0x197efe0,funcDecl=`int Widget::size() const ',related=`',overload=0,isFunc=1 mGrpId=-1 tArgList=(nil) (#=0) spec=0 lang=200
findMember() Parse results:
  namespaceName=`'
  className=`Widget`
  funcType=`int'
  funcSpec=`'
  funcName=`size'
  funcArgs=`() const'
  funcTempList=`'
  funcDecl=`int Widget::size'
  related=`'
  exceptions=`'
  isRelated=0
  isMemberOf=0
  isFriend=0
  isFunc=1

1. funcName=`size'
2. member name exists (2 members with this name)
3. member definition found, scope needed=`Widget' scope=`Widget' args=`' fileName=/tmp/test/example.cpp
4. class definition Widget found
5. matching `'`() const' className=Widget namespaceName=
6. match results of matchArguments2 = 1

您甚至可以使用其他非const变体复制此项int size().您将最终得到三个具有相同名称的成员.Doxygen目前无法处理具有相同名称的属性和函数,并且在这种情况下不会记录getter.

如果您不需要属性文档,则可以禁用您的Q_PROPERTY宏Doxyfile(如文档所示):

ENABLE_PREPROCESSING  = YES
MACRO_EXPANSION       = YES
PREDEFINED            = Q_PROPERTY(x)= 

这样,词法分析器就不会扫描了Q_PROPERTY.