qdoc: Added page for obsolete classes.

The classes marked \obsolete are no longer included in the
"All Classes" list. They are listed separately on an
"Obsolete Classes" list. The new page is reachable from the
"All Classes" page and from the "Grouped Classes" page.

4 files changed, 124 insertions, 25 deletions

diff --git a/doc/src/classes.qdoc b/doc/src/classes.qdoc
index dddc96f..9a5d3ec 100644
--- a/doc/src/classes.qdoc
+++ b/doc/src/classes.qdoc
@@ -44,13 +44,15 @@
     \title Qt's Classes
     \ingroup classlists
 
-    This is a list of all Qt classes excluding the \l{Qt 3
-    compatibility classes}. For a shorter list that only includes the
-    most frequently used classes, see \l{Qt's Main Classes}.
+    This is a list of all Qt classes. For a shorter list of the most
+    frequently used Qt classes, see \l{Qt's Main Classes}. For a list
+    of the classes provided for compatibility with Qt3, see \l{Qt 3
+    compatibility classes}. For classes that have been deprecated, see
+    the \l{Obsolete Classes} list.
 
     \generatelist classes
 
-    \sa {Qt 3 Compatibility Classes}, {Qt's Modules}
+    \sa {Qt 3 Compatibility Classes}, {Qt's Modules}, {Obsolete Classes}
 */
 
 /*!
diff --git a/doc/src/obsoleteclasses.qdoc b/doc/src/obsoleteclasses.qdoc
new file mode 100644
index 0000000..3658dfc
--- /dev/null
+++ b/doc/src/obsoleteclasses.qdoc
@@ -0,0 +1,59 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
+** package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://www.qtsoftware.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page obsoleteclasses.html
+    \group obsolete
+    \title Obsolete Classes
+    \ingroup classlists
+    \ingroup groups
+
+    \brief Qt classes that are obsolete (deprecated).
+
+    This is a list of Qt classes that are obsolete (deprecated). These
+    classes are provided to keep old source code working but they are
+    no longer maintained. We strongly advise against using these
+    classes in new code.
+
+    \generatelist obsoleteclasses
+
+    \sa {Qt's Classes}, {Qt's Modules}
+*/
diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp
index c007b9b..8d5e3d3 100644
--- a/tools/qdoc3/htmlgenerator.cpp
+++ b/tools/qdoc3/htmlgenerator.cpp
@@ -294,6 +294,7 @@ void HtmlGenerator::generateTree(const Tree *tree, CodeMarker *marker)
     nonCompatClasses.clear();
     mainClasses.clear();
     compatClasses.clear();
+    obsoleteClasses.clear();
     moduleClassMap.clear();
     moduleNamespaceMap.clear();
     funcIndex.clear();
@@ -381,7 +382,7 @@ int HtmlGenerator::generateAtom(const Atom *atom,
     case Atom::AutoLink:
         if (!inLink && !inContents && !inSectionHeading) {
             const Node *node = 0;
-            QString link = getLink(atom, relative, marker, node);
+            QString link = getLink(atom, relative, marker, &node);
             if (!link.isEmpty()) {
                 beginLink(link, node, relative, marker);
                 generateLink(atom, relative, marker);
@@ -567,6 +568,9 @@ int HtmlGenerator::generateAtom(const Atom *atom,
         else if (atom->string() == "compatclasses") {
             generateCompactList(relative, marker, compatClasses);
         }
+        else if (atom->string() == "obsoleteclasses") {
+            generateCompactList(relative, marker, obsoleteClasses);
+        }
         else if (atom->string() == "functionindex") {
             generateFunctionIndex(relative, marker);
         }
@@ -648,11 +652,12 @@ int HtmlGenerator::generateAtom(const Atom *atom,
     case Atom::Link:
         {
             const Node *node = 0;
-            QString myLink = getLink(atom, relative, marker, node);
-            if (myLink.isEmpty())
+            QString myLink = getLink(atom, relative, marker, &node);
+            if (myLink.isEmpty()) {
                 relative->doc().location().warning(tr("Cannot link to '%1' in %2")
                         .arg(atom->string())
                         .arg(marker->plainFullName(relative)));
+            }
             beginLink(myLink, node, relative, marker);
             skipAhead = 1;
         }
@@ -3261,6 +3266,9 @@ void HtmlGenerator::findAllClasses(const InnerNode *node)
                     if ((*c)->status() == Node::Compat) {
                         compatClasses.insert(className, *c);
                     }
+                    else if ((*c)->status() == Node::Obsolete) {
+                        obsoleteClasses.insert(className, *c);
+                    }
                     else {
                         nonCompatClasses.insert(className, *c);
                         if ((*c)->status() == Node::Main)
@@ -3457,10 +3465,10 @@ const QPair<QString,QString> HtmlGenerator::anchorForNode(const Node *node)
 QString HtmlGenerator::getLink(const Atom *atom,
                                const Node *relative,
                                CodeMarker *marker,
-                               const Node *node)
+                               const Node** node)
 {
     QString link;
-    node = 0;
+    *node = 0;
 
     if (atom->string().contains(":") &&
             (atom->string().startsWith("file:")
@@ -3484,40 +3492,69 @@ QString HtmlGenerator::getLink(const Atom *atom,
 
         QString first = path.first().trimmed();
         if (first.isEmpty()) {
-            node = relative;
+            *node = relative;
         }
         else if (first.endsWith(".html")) {
-            node = tre->root()->findNode(first, Node::Fake);
+            *node = tre->root()->findNode(first, Node::Fake);
         }
         else {
-            node = marker->resolveTarget(first, tre, relative);
-            if (!node)
-                node = tre->findFakeNodeByTitle(first);
-            if (!node)
-                node = tre->findUnambiguousTarget(first, targetAtom);
+            *node = marker->resolveTarget(first, tre, relative);
+            if (!*node)
+                *node = tre->findFakeNodeByTitle(first);
+            if (!*node)
+                *node = tre->findUnambiguousTarget(first, targetAtom);
         }
 
-        if (node) {
-            if (!node->url().isEmpty())
-                return node->url();
+        if (*node) {
+            if (!(*node)->url().isEmpty())
+                return (*node)->url();
             else
                 path.removeFirst();
         }
         else {
-            node = relative;
+            *node = relative;
+        }
+#if 0        
+        if (*node) {
+            if ((*node)->status() == Node::Obsolete) {
+                if (relative) {
+                    if (relative->parent() != *node) {
+                        if (relative->status() != Node::Obsolete) {
+                            qDebug() << "Link to Obsolete entity"
+                                     << (*node)->name();
+                            qDebug() << "  relative entity"
+                                     << relative->name();
+                        }
+                    }
+                }
+                else {
+                    qDebug() << "Link to Obsolete entity"
+                             << (*node)->name() << "no relative";
+                }
+            }
+#if 0                    
+            else if ((*node)->status() == Node::Deprecated) {
+                qDebug() << "Link to Deprecated entity";
+            }
+            else if ((*node)->status() == Node::Internal) {
+                qDebug() << "Link to Internal entity";
+            }
+            //else
+            //qDebug() << "Node Status:" << (*node)->status();
+#endif                
         }
-
+#endif
         while (!path.isEmpty()) {
-            targetAtom = tre->findTarget(path.first(), node);
+            targetAtom = tre->findTarget(path.first(), *node);
             if (targetAtom == 0)
                 break;
             path.removeFirst();
         }
 
         if (path.isEmpty()) {
-            link = linkForNode(node, relative);
+            link = linkForNode(*node, relative);
             if (targetAtom)
-                link += "#" + refForAtom(targetAtom, node);
+                link += "#" + refForAtom(targetAtom, *node);
         }
     }
     return link;
diff --git a/tools/qdoc3/htmlgenerator.h b/tools/qdoc3/htmlgenerator.h
index dc5e5cf..a7f4009 100644
--- a/tools/qdoc3/htmlgenerator.h
+++ b/tools/qdoc3/htmlgenerator.h
@@ -202,7 +202,7 @@ class HtmlGenerator : public PageGenerator
     virtual QString getLink(const Atom *atom, 
                             const Node *relative, 
                             CodeMarker *marker, 
-                            const Node *node = 0);
+                            const Node** node);
     virtual void generateDcf(const QString &fileBase, 
                              const QString &startPage,
                              const QString &title, DcfSection &dcfRoot);
@@ -256,6 +256,7 @@ class HtmlGenerator : public PageGenerator
     QMap<QString, const Node *> nonCompatClasses;
     QMap<QString, const Node *> mainClasses;
     QMap<QString, const Node *> compatClasses;
+    QMap<QString, const Node *> obsoleteClasses;
     QMap<QString, const Node *> namespaceIndex;
     QMap<QString, const Node *> serviceClasses;
 #ifdef QDOC_QML