From 3a36883394701b173dab9955d587495b846fc4eb Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@digia.com>
Date: Tue, 23 Jul 2013 12:41:53 +0200
Subject: qdoc: Improve format of obsolete members file

The link to the class reference page for the class that
contains the obsolete members is now embedded in the text
description of what the page contains. This change affects
both the obsolete members papge and the compatibility members
page. Without this change, the link to the class reference
page stands off on its own and makes it look like the class
itself is obsolete or maintained for compatibility with
previous versions. Since this is not the case, the link is
now embedded in the text description of the page.

Task-number: QTBUG-31379
Change-Id: Ic5f4554c8722ee193f2dfae9efd8adab98f32ca1
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
---
 src/tools/qdoc/htmlgenerator.cpp | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

(limited to 'src/tools/qdoc')

diff --git a/src/tools/qdoc/htmlgenerator.cpp b/src/tools/qdoc/htmlgenerator.cpp
index 5b023031ef..c5b7527a8b 100644
--- a/src/tools/qdoc/htmlgenerator.cpp
+++ b/src/tools/qdoc/htmlgenerator.cpp
@@ -2118,21 +2118,22 @@ QString HtmlGenerator::generateLowStatusMemberFile(InnerNode *inner,
     generateTitle(title, Text(), SmallSubTitle, inner, marker);
 
     if (status == CodeMarker::Compat) {
-        out() << "<p><b>The following class members are part of the "
+        out() << "<p><b>The following members of class "
+              << "<a href=\"" << linkForNode(inner, 0) << "\">"
+              << protectEnc(inner->name()) << "</a>"
+              << "are part of the "
                  "Qt compatibility layer.</b> We advise against "
                  "using them in new code.</p>\n";
     }
     else {
-        out() << "<p><b>The following class members are obsolete.</b> "
+        out() << "<p><b>The following members of class "
+              << "<a href=\"" << linkForNode(inner, 0) << "\">"
+              << protectEnc(inner->name()) << "</a>"
+              << " are obsolete.</b> "
               << "They are provided to keep old source code working. "
               << "We strongly advise against using them in new code.</p>\n";
     }
 
-    out() << "<p><ul><li><a href=\""
-          << linkForNode(inner, 0) << "\">"
-          << protectEnc(inner->name())
-          << " class reference</a></li></ul></p>\n";
-
     for (i = 0; i < sections.size(); ++i) {
         out() << "<h2>" << protectEnc(sections.at(i).name) << "</h2>\n";
         generateSectionList(sections.at(i), inner, marker, CodeMarker::Summary);
-- 
cgit v1.2.3