diff options
author | Martin Smith <martin.smith@digia.com> | 2013-05-15 13:27:55 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-05-20 15:20:26 +0200 |
commit | e469ee1340093e28234cc359a3e131998710030d (patch) | |
tree | 5273b657ec2d9e6c1e0f28d961b5e0c1a6dc2bf4 | |
parent | b735ef88a20e8a43e678b7b5a5dbf17741bd8c24 (diff) |
qdoc: Brief attribute was written incorrectly
The brief attribute for a C++ property was being written
after the <property> tag had been closed. This has been
fixed by explicitlty writing the brief attribute for each
XML tag that has a brief text to write.
Task-number: QTBUG-31149
Change-Id: Ic3857b8fa50cfb84536b838771751d8b92ed590e
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r-- | src/tools/qdoc/qdocindexfiles.cpp | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/src/tools/qdoc/qdocindexfiles.cpp b/src/tools/qdoc/qdocindexfiles.cpp index d984681a08..daba2cc78a 100644 --- a/src/tools/qdoc/qdocindexfiles.cpp +++ b/src/tools/qdoc/qdocindexfiles.cpp @@ -758,6 +758,7 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, writer.writeAttribute("since", node->since()); } + QString brief = node->doc().briefText().toString(); switch (node->type()) { case Node::Class: { @@ -773,6 +774,8 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, if (!node->moduleName().isEmpty()) writer.writeAttribute("module", node->moduleName()); writeMembersAttribute(writer, classNode, Node::Document, Node::Group, "groups"); + if (!brief.isEmpty()) + writer.writeAttribute("brief", brief); } break; case Node::Namespace: @@ -781,6 +784,8 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, if (!namespaceNode->moduleName().isEmpty()) writer.writeAttribute("module", namespaceNode->moduleName()); writeMembersAttribute(writer, namespaceNode, Node::Document, Node::Group, "groups"); + if (!brief.isEmpty()) + writer.writeAttribute("brief", brief); } break; case Node::Document: @@ -847,6 +852,8 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, writer.writeAttribute("module", node->moduleName()); } writeMembersAttribute(writer, docNode, Node::Document, Node::Group, "groups"); + if (!brief.isEmpty()) + writer.writeAttribute("brief", brief); } break; case Node::Function: @@ -906,6 +913,8 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, if (propertyNode) writer.writeAttribute("associated-property", propertyNode->name()); writer.writeAttribute("type", functionNode->returnType()); + if (!brief.isEmpty()) + writer.writeAttribute("brief", brief); } break; case Node::QmlProperty: @@ -914,12 +923,16 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, writer.writeAttribute("type", qpn->dataType()); writer.writeAttribute("attached", qpn->isAttached() ? "true" : "false"); writer.writeAttribute("writable", qpn->isWritable(qdb_) ? "true" : "false"); + if (!brief.isEmpty()) + writer.writeAttribute("brief", brief); } break; case Node::Property: { const PropertyNode* propertyNode = static_cast<const PropertyNode*>(node); writer.writeAttribute("type", propertyNode->dataType()); + if (!brief.isEmpty()) + writer.writeAttribute("brief", brief); foreach (const Node* fnNode, propertyNode->getters()) { if (fnNode) { const FunctionNode* functionNode = static_cast<const FunctionNode*>(fnNode); @@ -959,14 +972,13 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, const VariableNode* variableNode = static_cast<const VariableNode*>(node); writer.writeAttribute("type", variableNode->dataType()); writer.writeAttribute("static", variableNode->isStatic() ? "true" : "false"); + if (!brief.isEmpty()) + writer.writeAttribute("brief", brief); } break; default: break; } - QString brief = node->doc().briefText().toString(); - if (!brief.isEmpty()) - writer.writeAttribute("brief", brief); // Inner nodes and function nodes contain child nodes of some sort, either // actual child nodes or function parameters. For these, we close the |