summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/cppcodemarker.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-10-02 13:52:17 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-10-07 10:05:51 +0000
commit694d30035593addc377fea374d1dbe8e3f5ca503 (patch)
tree44698328ab3a799706ada5a31c171c618c5b8053 /src/tools/qdoc/cppcodemarker.cpp
parent9684e16f002f4f813c49141de2933a7fb0c71461 (diff)
qdoc: Avoid extra spaces in function synopses
Instead of blindly leading each parameter name with a space, check if the data type name is empty first. This prevents extra spaces from appearing in QML method signatures, which can be documented with parameter names only, without data types. Change-Id: I726f8c29839430186fcae4ac19d00404233395e0 Task-number: QTWEBSITE-691 Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc/cppcodemarker.cpp')
-rw-r--r--src/tools/qdoc/cppcodemarker.cpp6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/tools/qdoc/cppcodemarker.cpp b/src/tools/qdoc/cppcodemarker.cpp
index 774ff115b9..3b38745b70 100644
--- a/src/tools/qdoc/cppcodemarker.cpp
+++ b/src/tools/qdoc/cppcodemarker.cpp
@@ -156,12 +156,13 @@ QString CppCodeMarker::markedUpSynopsis(const Node *node,
if (func->metaness() != FunctionNode::MacroWithoutParams) {
synopsis += "(";
if (!func->parameters().isEmpty()) {
- //synopsis += QLatin1Char(' ');
QVector<Parameter>::ConstIterator p = func->parameters().constBegin();
while (p != func->parameters().constEnd()) {
if (p != func->parameters().constBegin())
synopsis += ", ";
synopsis += typified((*p).dataType());
+ if (!(*p).dataType().isEmpty())
+ synopsis += QLatin1Char(' ');
if (style != Subpage && !(*p).name().isEmpty())
synopsis +=
"<@param>" + protect((*p).name()) + "</@param>";
@@ -170,7 +171,6 @@ QString CppCodeMarker::markedUpSynopsis(const Node *node,
synopsis += " = " + protect((*p).defaultValue());
++p;
}
- //synopsis += QLatin1Char(' ');
}
synopsis += QLatin1Char(')');
}
@@ -334,7 +334,7 @@ QString CppCodeMarker::markedUpQmlItem(const Node* node, bool summary)
synopsis += ", ";
synopsis += typified((*p).dataType());
if (!(*p).name().isEmpty()) {
- if (!synopsis.endsWith(QLatin1Char('(')))
+ if (!(*p).dataType().isEmpty())
synopsis += QLatin1Char(' ');
synopsis += "<@param>" + protect((*p).name()) + "</@param>";
}