summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThibaut Cuvelier <cuvelier.thibaut@gmail.com>2019-11-14 00:05:39 +0100
committerThibaut Cuvelier <cuvelier.thibaut@gmail.com>2019-11-28 12:51:22 +0100
commit0b0e82d80adb9dd57bd4a2aa7508c6a4caa8acc1 (patch)
tree78dc0f8d82e3da9e0df11895d65f8a43aff228c2
parent8437ead59e73007f05346068ff0979352488a218 (diff)
Rename functions to better describe their impact
Also, remove an argument they were muting to instead return a new value. Change-Id: Ibe6c73d36988ed76884c5d5bbdd656bfb5221b3e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--src/qdoc/generator.cpp8
-rw-r--r--src/qdoc/parameters.cpp13
-rw-r--r--src/qdoc/parameters.h4
3 files changed, 13 insertions, 12 deletions
diff --git a/src/qdoc/generator.cpp b/src/qdoc/generator.cpp
index b7ff6f8cb..19af09209 100644
--- a/src/qdoc/generator.cpp
+++ b/src/qdoc/generator.cpp
@@ -1652,14 +1652,13 @@ void Generator::generateOverloadedSignal(const Node *node, CodeMarker *marker)
}
// We have an overloaded signal, show an example. Note, for const
- // overloaded signals one should use Q{Const,NonConst}Overload, but
+ // overloaded signals, one should use Q{Const,NonConst}Overload, but
// it is very unlikely that we will ever have public API overloading
// signals by const.
QString code = "connect(" + objectName + ", QOverload<";
- func->parameters().getTypeList(code);
+ code += func->parameters().generateTypeList();
code += ">::of(&" + func->parent()->name() + "::" + func->name() + "),\n [=](";
- func->parameters().getTypeAndNameList(code);
-
+ code += func->parameters().generateTypeAndNameList();
code += "){ /* ... */ });";
Text text;
@@ -1680,7 +1679,6 @@ void Generator::generateOverloadedSignal(const Node *node, CodeMarker *marker)
generateText(text, node, marker);
}
-
/*!
Traverses the database recursively to generate all the documentation.
*/
diff --git a/src/qdoc/parameters.cpp b/src/qdoc/parameters.cpp
index 44178c9d9..6ed5e8250 100644
--- a/src/qdoc/parameters.cpp
+++ b/src/qdoc/parameters.cpp
@@ -517,11 +517,11 @@ void Parameters::getNames(QSet<QString> &names) const
}
/*!
- Construct a list of the parameter types and append it to
- \a out. \a out is not cleared first.
+ Construct a list of the parameter types and return it.
*/
-void Parameters::getTypeList(QString &out) const
+QString Parameters::generateTypeList() const
{
+ QString out;
if (count() > 0) {
for (int i = 0; i < count(); ++i) {
if (i > 0)
@@ -529,14 +529,16 @@ void Parameters::getTypeList(QString &out) const
out += parameters_.at(i).type();
}
}
+ return out;
}
/*!
Construct a list of the parameter type/name pairs and
- append it to \a out. \a out is not cleared first.
+ return it.
*/
-void Parameters::getTypeAndNameList(QString &out) const
+QString Parameters::generateTypeAndNameList() const
{
+ QString out;
if (count() > 0) {
for (int i = 0; i < count(); ++i) {
if (i != 0)
@@ -548,6 +550,7 @@ void Parameters::getTypeAndNameList(QString &out) const
out += p.name();
}
}
+ return out;
}
/*!
diff --git a/src/qdoc/parameters.h b/src/qdoc/parameters.h
index dcd4517eb..9ab3db5e2 100644
--- a/src/qdoc/parameters.h
+++ b/src/qdoc/parameters.h
@@ -98,8 +98,8 @@ public:
QString rawSignature(bool names = false, bool values = false) const;
void set(const QString &signature);
void getNames(QSet<QString> &names) const;
- void getTypeList(QString &out) const;
- void getTypeAndNameList(QString &out) const;
+ QString generateTypeList() const;
+ QString generateTypeAndNameList() const;
bool match(const Parameters &parameters) const;
private: