diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-07-24 10:18:55 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-07-30 17:38:47 +0200 |
commit | c6ccd278188cb460276ea4d942519b760576a202 (patch) | |
tree | 30df938e4bb22ff23d6ee66d0a5d3cbd84c69699 /src/tools/qdoc/htmlgenerator.h | |
parent | eea5b8bf8b835eb2bc96aebc6a81acd4c3ca376c (diff) |
Doc: Unified the summary for C++ classes and QML types.
The placement of the header, since, inherits,
instantiates, and instantiated-by are now in a table.
For C++ classes:
Header: #include <class name>
Since: <version>
Instantiated by: <QML type>
Inherits: <parent class>
Inherited by: <list of classes>
For QML types:
To import: import <QML module>
Since: <version>
Inherited by:<list of QML types>
Instantiates: <C++ class>
Inherits: <parent QML type>
Inherited by: <list of QML types>
This is only a part of the work being done for
QTBUG-32172.
Task-number: QTBUG-32172
Change-Id: Ia9d29e824ef7ab4052ea59c6397b5f8fd24022b9
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/tools/qdoc/htmlgenerator.h')
-rw-r--r-- | src/tools/qdoc/htmlgenerator.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/tools/qdoc/htmlgenerator.h b/src/tools/qdoc/htmlgenerator.h index 54747cd6d6..5592efa998 100644 --- a/src/tools/qdoc/htmlgenerator.h +++ b/src/tools/qdoc/htmlgenerator.h @@ -139,6 +139,10 @@ private: const Node *relative, CodeMarker *marker); void generateFooter(const Node *node = 0); + void generateRequisites(InnerNode *inner, + CodeMarker *marker); + void generateQmlRequisites(QmlClassNode *qcn, + CodeMarker *marker); void generateBrief(const Node *node, CodeMarker *marker, const Node *relative = 0); @@ -182,6 +186,7 @@ private: void generateQmlInstantiates(QmlClassNode* qcn, CodeMarker* marker); void generateInstantiatedBy(ClassNode* cn, CodeMarker* marker); + void generateRequisitesTable(const QStringList& requisitesOrder, QMap<QString, Text>& requisites); void generateSection(const NodeList& nl, const Node *relative, CodeMarker *marker, |