From c63cda4439eda216ab1d60decb9b9d710e860fd3 Mon Sep 17 00:00:00 2001
From: Sebastian <versat@users.noreply.github.com>
Date: Fri, 9 Mar 2018 20:19:59 +0100
Subject: [PATCH] Qt library: Add missing comments and attributes and fixed
 some configurations (#1110)

---
 cfg/qt.cfg | 128 ++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 116 insertions(+), 12 deletions(-)

diff --git a/cfg/qt.cfg b/cfg/qt.cfg
index 6a17b4325..ebe322818 100644
--- a/cfg/qt.cfg
+++ b/cfg/qt.cfg
@@ -61,6 +61,13 @@
   </reflection>
   <define name="SIGNAL(X)" value="#X"/>
   <define name="SLOT(X)" value="#X"/>
+  <!-- QMetaObject::Connection QObject::connect(const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type = Qt::AutoConnection) const -->
+  <!-- QMetaObject::Connection QObject::connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type = Qt::AutoConnection) -->
+  <!-- QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type = Qt::AutoConnection) -->
+  <!-- QMetaObject::Connection QObject::connect(const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type = Qt::AutoConnection) -->
+  <!-- QMetaObject::Connection QObject::connect(const QObject *sender, PointerToMemberFunction signal, Functor functor) -->
+  <!-- QMetaObject::Connection QObject::connect(const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type = Qt::AutoConnection) -->
+  <!-- TODO: function configuration should match all overloaded functions and ideally only QObject methods -->
   <function name="connect">
     <noreturn>false</noreturn>
     <arg nr="1">
@@ -78,6 +85,12 @@
       <not-uninit/>
     </arg>
   </function>
+  <!-- bool QObject::disconnect(const QObject *sender, const char *signal, const QObject *receiver, const char *method) -->
+  <!-- bool QObject::disconnect(const char *signal = Q_NULLPTR, const QObject *receiver = Q_NULLPTR, const char *method = Q_NULLPTR) const -->
+  <!-- bool QObject::disconnect(const QObject *receiver, const char *method = Q_NULLPTR) const -->
+  <!-- bool QObject::disconnect(const QMetaObject::Connection &connection) -->
+  <!-- bool QObject::disconnect(const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) -->
+  <!-- TODO: function configuration should match all overloaded functions and ideally only QObject methods -->
   <function name="disconnect">
     <noreturn>false</noreturn>
     <arg nr="1">
@@ -95,31 +108,51 @@
       <not-uninit/>
     </arg>
   </function>
+  <!-- QString QObject::tr(const char *sourceText, const char *disambiguation = Q_NULLPTR, int n = -1) //static -->
   <function name="tr,QObject::tr">
     <noreturn>false</noreturn>
+    <returnValue type="QString"/>
     <use-retval/>
+    <leak-ignore/>
     <arg nr="1">
+      <not-null/>
+      <not-uninit/>
       <strz/>
     </arg>
+    <arg nr="2" default="0">
+      <not-uninit/>
+    </arg>
+    <arg nr="3" default="-1">
+      <not-uninit/>
+    </arg>
   </function>
+  <!-- void QSettings::setValue(const QString &key, const QVariant &value) -->
   <function name="QSettings::setValue">
     <noreturn>false</noreturn>
+    <leak-ignore/>
     <arg nr="1">
       <strz/>
       <not-uninit/>
       <not-null/>
     </arg>
-    <arg nr="2"/>
+    <arg nr="2">
+      <not-uninit/>
+    </arg>
   </function>
+  <!-- QVariant QSettings::value(const QString &key, const QVariant &defaultValue = QVariant()) const -->
   <function name="QSettings::value">
     <noreturn>false</noreturn>
+    <returnValue type="QVariant"/>
     <use-retval/>
+    <const/>
     <arg nr="1">
       <strz/>
       <not-uninit/>
       <not-null/>
     </arg>
-    <arg nr="2"/>
+    <arg nr="2" default="QVariant()">
+      <not-uninit/>
+    </arg>
   </function>
   <!-- QString & QString::sprintf(const char * cformat, ...); -->
   <function name="QString::sprintf">
@@ -141,18 +174,23 @@
       <not-uninit/>
     </arg>
   </function>
-  <!-- const QChar  QString::at(int position) const -->
+  <!-- const QChar QString::at(int position) const -->
   <function name="QList::at,QString::at,QStringList::at">
     <noreturn>false</noreturn>
+    <returnValue type="const QChar"/>
     <use-retval/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
+      <valid>0:</valid>
     </arg>
   </function>
   <!-- int QString::capacity() const -->
   <function name="QString::capacity">
     <noreturn>false</noreturn>
+    <returnValue type="int"/>
     <use-retval/>
+    <const/>
   </function>
   <!-- iterator QList::..() -->
   <function name="QList::begin,QList::end,QList::cbegin,QList::cend,QList::constBegin,QList::constEnd,QList::rbegin,QList::rend,QList::crbegin,QList::crend">
@@ -180,14 +218,25 @@
   <function name="QList::clear,QString::clear">
     <noreturn>false</noreturn>
   </function>
-  <!-- int QString::compare() const -->
+  <!-- int QString::compare(const QString &s1, const QString &s2, Qt::CaseSensitivity cs = Qt::CaseSensitive) //static -->
+  <!-- int QString::compare(QLatin1String other, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::compare(const QString &other, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::compare(const QString &s1, QLatin1String s2, Qt::CaseSensitivity cs = Qt::CaseSensitive) //static -->
+  <!-- int QString::compare(QLatin1String s1, const QString &s2, Qt::CaseSensitivity cs = Qt::CaseSensitive) //static -->
+  <!-- int QString::compare(const QStringRef &ref, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::compare(const QString &s1, const QStringRef &s2, Qt::CaseSensitivity cs = Qt::CaseSensitive) //static -->
   <function name="QString::compare">
     <noreturn>false</noreturn>
+    <returnValue type="int"/>
     <use-retval/>
+    <leak-ignore/>
     <arg nr="1">
       <not-uninit/>
     </arg>
-    <arg nr="2" default="Qt::CaseSensitive">
+    <arg nr="2" default="0">
+      <not-uninit/>
+    </arg>
+    <arg nr="3" default="0">
       <not-uninit/>
     </arg>
   </function>
@@ -198,6 +247,7 @@
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="bool"/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
     </arg>
@@ -209,6 +259,7 @@
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="bool"/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
     </arg>
@@ -223,6 +274,7 @@
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="bool"/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
     </arg>
@@ -240,6 +292,7 @@
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="signed int"/>
+    <const/>
   </function>
   <!-- bool QList::empty() const -->
   <!-- bool QList::isEmpty() const -->
@@ -251,8 +304,9 @@
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="bool"/>
+    <const/>
   </function>
-  <!-- QString QString::fromStdString(const std::string &str) -->
+  <!-- QString QString::fromStdString(const std::string &str) //static -->
   <function name="QString::fromStdString">
     <noreturn>false</noreturn>
     <use-retval/>
@@ -265,26 +319,34 @@
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="signed int"/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
     </arg>
   </function>
-  <!-- int QString::indexOf(const QString &str, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::indexOf(const QString &str, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::indexOf(QChar ch, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::indexOf(QLatin1String str, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::indexOf(const QStringRef &str, int from = 0, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- int QString::indexOf(const QRegExp &rx, int from = 0) const -->
+  <!-- int QString::indexOf(QRegExp &rx, int from = 0) const -->
+  <!-- int QString::indexOf(const QRegularExpression &re, int from = 0) const -->
+  <!-- int QString::indexOf(const QRegularExpression &re, int from, QRegularExpressionMatch *rmatch) const -->
   <function name="QString::indexOf">
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="signed int"/>
-    <arg nr="1">
-      <not-uninit/>
-    </arg>
-    <arg nr="2" default="Qt::CaseSensitive">
+    <const/>
+    <arg nr="any">
       <not-uninit/>
     </arg>
   </function>
   <!-- bool QString::isRightToLeft() const -->
   <function name="QString::isRightToLeft">
     <noreturn>false</noreturn>
+    <returnValue type="bool"/>
     <use-retval/>
+    <const/>
   </function>
   <!-- int QList::lastIndexOf(const T &value, int from = -1) const -->
   <!-- int QStringList::lastIndexOf(const QString &value, int from = -1) const -->
@@ -304,6 +366,7 @@
     <noreturn>false</noreturn>
     <use-retval/>
     <returnValue type="signed int"/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
     </arg>
@@ -317,7 +380,9 @@
   <!-- QString QString::left(int n) const -->
   <function name="QString::left">
     <noreturn>false</noreturn>
+    <returnValue type="QString"/>
     <use-retval/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
     </arg>
@@ -351,62 +416,100 @@
       <not-uninit/>
     </arg>
   </function>
+  <!-- QString QString::right(int n) const -->
   <function name="QString::right">
     <noreturn>false</noreturn>
+    <returnValue type="QString"/>
     <use-retval/>
+    <leak-ignore/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
       <not-bool/>
       <valid>0:</valid>
     </arg>
   </function>
+  <!-- QStringList QString::split(const QString &sep, SplitBehavior behavior = KeepEmptyParts, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- QStringList QString::split(QChar sep, SplitBehavior behavior = KeepEmptyParts, Qt::CaseSensitivity cs = Qt::CaseSensitive) const -->
+  <!-- QStringList QString::split(const QRegExp &rx, SplitBehavior behavior = KeepEmptyParts) const -->
+  <!-- QStringList QString::split(const QRegularExpression &re, SplitBehavior behavior = KeepEmptyParts) const -->
   <function name="QString::split">
     <noreturn>false</noreturn>
+    <returnValue type="QStringList"/>
     <use-retval/>
+    <leak-ignore/>
+    <const/>
     <arg nr="1">
       <not-uninit/>
     </arg>
   </function>
+  <!-- int QString::toInt(bool *ok = Q_NULLPTR, int base = 10) const -->
   <function name="QString::toInt">
     <noreturn>false</noreturn>
+    <returnValue type="int"/>
     <use-retval/>
+    <leak-ignore/>
+    <const/>
     <arg nr="1" default="0">
       <not-uninit/>
     </arg>
     <arg nr="2" default="10">
       <not-uninit/>
-      <valid>0,2:32</valid>
+      <valid>0,2:36</valid>
     </arg>
   </function>
+  <!-- QString QString::toLower() const -->
   <function name="QString::toLower">
     <noreturn>false</noreturn>
+    <returnValue type="QString"/>
     <use-retval/>
+    <const/>
   </function>
+  <!-- std::string QString::toStdString() const -->
   <function name="QString::toStdString">
     <noreturn>false</noreturn>
+    <returnValue type="std::string"/>
     <use-retval/>
+    <const/>
   </function>
+  <!-- QString QString::toUpper() const -->
   <function name="QString::toUpper">
     <noreturn>false</noreturn>
+    <returnValue type="QString"/>
     <use-retval/>
+    <const/>
   </function>
+  <!-- QByteArray QString::toUtf8() const -->
   <function name="QString::toUtf8">
     <noreturn>false</noreturn>
+    <returnValue type="QByteArray"/>
     <use-retval/>
+    <const/>
   </function>
+  <!-- QString QString::trimmed() const -->
   <function name="QString::trimmed">
     <noreturn>false</noreturn>
+    <returnValue type="QString"/>
     <use-retval/>
+    <const/>
   </function>
+  <!-- void QMetaObject::connectSlotsByName(QObject *object) -->
   <function name="QMetaObject::connectSlotsByName">
     <noreturn>false</noreturn>
+    <leak-ignore/>
     <arg nr="1">
       <not-null/>
     </arg>
   </function>
+  <!-- QString QDir::fromNativeSeparators(const QString &pathName) -->
+  <!-- QString QDir::toNativeSeparators(const QString &pathName) -->
   <function name="QDir::fromNativeSeparators,QDir::toNativeSeparators">
     <noreturn>false</noreturn>
+    <returnValue type="QString"/>
     <use-retval/>
+    <arg nr="1">
+      <not-uninit/>
+    </arg>
   </function>
   <!-- bool QFile::open(OpenMode mode) -->
   <!-- bool QFile::open(FILE *fh, OpenMode mode, FileHandleFlags handleFlags = DontCloseHandle) -->
@@ -445,6 +548,7 @@
     <noreturn>false</noreturn>
     <returnValue type="qint64"/>
     <use-retval/>
+    <const/>
   </function>
   <container id="qtContainer" opLessAllowed="false">
     <type templateParameter="0"/>