1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QDoc: Remove generateQmlDesc and use generateApiDesc instead.

Browse Source 
generateQmlDesc was basically a copy of generateApiDesc. Just using
generateApiDesc also fixes a bug with the generation of a <shortDesc>
inside an <apiDesc>

Change-Id: I129a24ab0244283cc394c2afacc0f8227e4e5a88
Reviewed-by: Martin Smith <martin.smith@nokia.com>
This commit is contained in:
Casper van Donderen 2012-05-09 14:27:40 +02:00 committed by Qt by Nokia
parent bbe9b28c0b
commit 66ca9382c9
2 changed files with 6 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/tools/qdoc/ditaxmlgenerator.cpp
View File

@ -4496,7 +4496,7 @@ void DitaXmlGenerator::generateDetailedQmlMember(Node* node,
if (qpgn->childNodes().size() == 1) { if (qpgn->childNodes().size() == 1) {
qpn = static_cast<QmlPropertyNode*>(*p); qpn = static_cast<QmlPropertyNode*>(*p);
startQmlProperty(qpn,relative,marker); startQmlProperty(qpn,relative,marker);
writeQmlDesc(node, marker); writeApiDesc(node, marker, node->title());
writeEndTag(); // </qmlPropertyDetail> writeEndTag(); // </qmlPropertyDetail>
writeEndTag(); // </qmlProperty> writeEndTag(); // </qmlProperty>
} }
@ -4509,7 +4509,7 @@ void DitaXmlGenerator::generateDetailedQmlMember(Node* node,
//writeCharacters("..."); //writeCharacters("...");
writeEndTag(); // </apiName> writeEndTag(); // </apiName>
writeStartTag(DT_qmlPropertyGroupDetail); writeStartTag(DT_qmlPropertyGroupDetail);
writeQmlDesc(node, marker); writeApiDesc(node, marker, node->title());
writeEndTag(); // </qmlPropertyGroupDetail> writeEndTag(); // </qmlPropertyGroupDetail>
while (p != qpgn->childNodes().end()) { while (p != qpgn->childNodes().end()) {
if ((*p)->type() == Node::QmlProperty) { if ((*p)->type() == Node::QmlProperty) {
@ -4527,7 +4527,7 @@ void DitaXmlGenerator::generateDetailedQmlMember(Node* node,
qpn = static_cast<QmlPropertyNode*>(node); qpn = static_cast<QmlPropertyNode*>(node);
if (qpn->qmlPropNodes().isEmpty()) { if (qpn->qmlPropNodes().isEmpty()) {
startQmlProperty(qpn,relative,marker); startQmlProperty(qpn,relative,marker);
writeQmlDesc(node, marker); writeApiDesc(node, marker, node->title());
writeEndTag(); // </qmlPropertyDetail> writeEndTag(); // </qmlPropertyDetail>
writeEndTag(); // </qmlProperty> writeEndTag(); // </qmlProperty>
} }
@ -4536,7 +4536,7 @@ void DitaXmlGenerator::generateDetailedQmlMember(Node* node,
if (n->type() == Node::QmlProperty) { if (n->type() == Node::QmlProperty) {
qpn = static_cast<QmlPropertyNode*>(n); qpn = static_cast<QmlPropertyNode*>(n);
startQmlProperty(qpn,relative,marker); startQmlProperty(qpn,relative,marker);
writeQmlDesc(node, marker); writeApiDesc(node, marker, node->title());
writeEndTag(); // </qmlPropertyDetail> writeEndTag(); // </qmlPropertyDetail>
writeEndTag(); // </qmlProperty> writeEndTag(); // </qmlProperty>
} }
@ -4555,7 +4555,7 @@ void DitaXmlGenerator::generateDetailedQmlMember(Node* node,
//writeCharacters("..."); //writeCharacters("...");
writeEndTag(); // </apiName> writeEndTag(); // </apiName>
writeStartTag(DT_qmlPropertyGroupDetail); writeStartTag(DT_qmlPropertyGroupDetail);
writeQmlDesc(node, marker); writeApiDesc(node, marker, node->title());
writeEndTag(); // </qmlPropertyGroupDetail> writeEndTag(); // </qmlPropertyGroupDetail>
NodeList::ConstIterator p = qpn->qmlPropNodes().begin(); NodeList::ConstIterator p = qpn->qmlPropNodes().begin();
while (p != qpn->qmlPropNodes().end()) { while (p != qpn->qmlPropNodes().end()) {
@ -4606,26 +4606,11 @@ void DitaXmlGenerator::writeQmlRef(DitaTag tag,
writeEndTag(); // </qmlAttached> writeEndTag(); // </qmlAttached>
} }
writeEndTag(); // </qmlXxxDef> writeEndTag(); // </qmlXxxDef>
writeQmlDesc(node, marker); writeApiDesc(node, marker, node->title());
writeEndTag(); // </qmlXxxDetail> writeEndTag(); // </qmlXxxDetail>
writeEndTag(); // tag writeEndTag(); // tag
} }
/*!
Writes the <apiDesc> tag and its contents for the \a node.
The \a marker is used for markeing up the text body.
*/
void DitaXmlGenerator::writeQmlDesc(Node* node, CodeMarker* marker)
{
writeStartTag(DT_apiDesc);
generateStatus(node, marker);
generateBody(node, marker);
generateThreadSafeness(node, marker);
generateSince(node, marker);
generateAlsoList(node, marker);
writeEndTag(); // </apiDesc>
}
/*! /*!
This generates a <qmlTypeDef> in which the This generates a <qmlTypeDef> in which the
QML module name and version number are specified. QML module name and version number are specified.

1
src/tools/qdoc/ditaxmlgenerator.h
View File

@ -418,7 +418,6 @@ private:
Node* node, Node* node,
const InnerNode* relative, const InnerNode* relative,
CodeMarker* marker); CodeMarker* marker);
void writeQmlDesc(Node* node, CodeMarker* marker);
void generateDetailedQmlMember(Node* node, void generateDetailedQmlMember(Node* node,
const InnerNode* relative, const InnerNode* relative,
CodeMarker* marker); CodeMarker* marker);