From c6ccd278188cb460276ea4d942519b760576a202 Mon Sep 17 00:00:00 2001
From: Jerome Pasion <jerome.pasion@digia.com>
Date: Wed, 24 Jul 2013 10:18:55 +0200
Subject: Doc: Unified the summary for C++ classes and QML types.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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>
---
 src/tools/qdoc/htmlgenerator.h | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/tools/qdoc/htmlgenerator.h')

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,
-- 
cgit v1.2.3