qdoc: Add support for listing all examples from all modules

This commit adds a new argument for \generatelist command, which
enables the generation of an 'example index' page:

    \generatelist annotatedexamples

This will generate a set of tables; one for each module, prefixed
by a header titled with the module name. The table is an annotated
list (title + brief description) for each documented example.

A human-readable name for each module is read from the
navigation.landingpage .qdocconf variable. This name is written
to / read back from the index files as 'indexTitle' attribute.
Examples for modules that do not define a landing page title
are listed in a single table with no accompanying header.

Change-Id: Icb7fa6fb40ec9a0dfce1bf8282c8782a69ec0028
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>

1 files changed, 3 insertions, 0 deletions

diff --git a/src/qdoc/tree.h b/src/qdoc/tree.h
index 1fef15bc6..0558d693c 100644
--- a/src/qdoc/tree.h
+++ b/src/qdoc/tree.h
@@ -227,6 +227,8 @@ class Tree
     long incrementLinkCount() { return --linkCount_; }
     void clearLinkCount() { linkCount_ = 0; }
     long linkCount() const { return linkCount_; }
+    const QString& indexTitle() const { return indexTitle_; }
+    void setIndexTitle(const QString &t) { indexTitle_ = t; }
 
 private:
     bool treeHasBeenAnalyzed_;
@@ -235,6 +237,7 @@ private:
     QString camelCaseModuleName_;
     QString physicalModuleName_;
     QString indexFileName_;
+    QString indexTitle_;
     QDocDatabase* qdb_;
     NamespaceNode root_;
     PropertyMap unresolvedPropertyMap;