qdoc: Add index of obsolete members to obsolete page

qdoc has been modified to emit a compact list of the
classes that have one or more obsolete members. The
command is:

\generatelist obsoletecppmembers

This generates an index of all such classes,
where each class name is a link to the class's
subpage of obsolete members. A class's subpage
of obsolete members is also accessible from the
class's reference page, but now it is also
accessible from this index.

Also, The command shown has been added to the
page obsoleteclasses.html in the generated
output. This page already contains the index
of obsolete classes.

Currently, no such output is generated for
QML types and QML types with obsolete members.
But qdoc does accept commands for those:

\generatelist obsoleteqmltypes

and

\generatelist obsoleteqmlmembers

...but qdoc doesn't know what to do with
those commands yet.

Task-number: QTBUG-30270
Change-Id: If19a3b977f64c948e4bd6f14a9e0a287419baa8a
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

1 files changed, 6 insertions, 1 deletions

diff --git a/src/tools/qdoc/generator.h b/src/tools/qdoc/generator.h
index e4bc85b2bc..28a9ae5ce8 100644
--- a/src/tools/qdoc/generator.h
+++ b/src/tools/qdoc/generator.h
@@ -50,7 +50,7 @@
 #include <qstring.h>
 #include <qstringlist.h>
 #include <qtextstream.h>
-
+#include "config.h"
 #include "node.h"
 #include "text.h"
 
@@ -70,6 +70,7 @@ class Generator
 
 public:
     enum Passes { Both, Prepare, Generate };
+    enum ListType { Generic, Obsolete };
 
     Generator();
     virtual ~Generator();
@@ -81,11 +82,13 @@ public:
     virtual void terminateGenerator();
 
     QString fullDocumentLocation(const Node *node, bool subdir = false);
+    const Config* config() { return config_; }
 
     static Generator *currentGenerator() { return currentGenerator_; }
     static Generator *generatorForFormat(const QString& format);
     static void initialize(const Config& config);
     static const QString& outputDir() { return outDir_; }
+    static const QString& outputSubdir() { return outSubdir_; }
     static void terminate();
     static void writeOutFileNames();
     static void augmentImageDirs(QSet<QString>& moreImageDirs);
@@ -192,6 +195,7 @@ private:
     static QMap<QString, QStringList> imgFileExts;
     static QString project;
     static QString outDir_;
+    static QString outSubdir_;
     static QSet<QString> outputFormats;
     static QHash<QString, QString> outputPrefixes;
     static QStringList scriptDirs;
@@ -221,6 +225,7 @@ private:
     QRegExp tag;
 
  protected:
+    const Config* config_;
     QDocDatabase* qdb_;
     bool inLink_;
     bool inContents_;