From d15309edeed53da021d058218e4c739e5903d8fd Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@digia.com>
Date: Wed, 16 Jul 2014 14:35:00 +0200
Subject: qdoc: Support use of \value command outside \enum topic.

Even though qdoc accepts the \value command(s) anywhere in the
documentation and generates tables for them, the produced output was
invalid for documentation topics other than \enum.

This change fixes the issue by not trying to resolve the enumeration
values and removing the 'Value' column for generated tables when the
\value command is used outside c++ enum documentation topic.

This enables, for example, the use of the \value command for
documenting acceptable values for QML enumeration properties,
without having to use custom lists or tables.

Task-number: QTBUG-35019
Change-Id: I597b2f9d7d03d4ab72f276752ddf53e1c405313c
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
---
 src/tools/qdoc/htmlgenerator.cpp | 32 +++++++++++++++++---------------
 1 file changed, 17 insertions(+), 15 deletions(-)

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

diff --git a/src/tools/qdoc/htmlgenerator.cpp b/src/tools/qdoc/htmlgenerator.cpp
index 46c90205fe..7a19e3c027 100644
--- a/src/tools/qdoc/htmlgenerator.cpp
+++ b/src/tools/qdoc/htmlgenerator.cpp
@@ -854,21 +854,24 @@ int HtmlGenerator::generateAtom(const Atom *atom, const Node *relative, CodeMark
             out() << "<dl>\n";
         }
         else if (atom->string() == ATOM_LIST_VALUE) {
+            out() << "<table class=\"valuelist\">";
             threeColumnEnumValueTable_ = isThreeColumnEnumValueTable(atom);
             if (threeColumnEnumValueTable_) {
-                out() << "<table class=\"valuelist\">";
                 if (++numTableRows_ % 2 == 1)
                     out() << "<tr valign=\"top\" class=\"odd\">";
                 else
                     out() << "<tr valign=\"top\" class=\"even\">";
 
-                out() << "<th class=\"tblConst\">Constant</th>"
-                      << "<th class=\"tblval\">Value</th>"
-                      << "<th class=\"tbldscr\">Description</th></tr>\n";
+                out() << "<th class=\"tblConst\">Constant</th>";
+
+                // If not in \enum topic, skip the value column
+                if (relative->type() == Node::Enum)
+                    out() << "<th class=\"tblval\">Value</th>";
+
+                out() << "<th class=\"tbldscr\">Description</th></tr>\n";
             }
             else {
-                out() << "<table class=\"valuelist\">"
-                      << "<tr><th class=\"tblConst\">Constant</th><th class=\"tblVal\">Value</th></tr>\n";
+                out() << "<tr><th class=\"tblConst\">Constant</th><th class=\"tblVal\">Value</th></tr>\n";
             }
         }
         else {
@@ -903,19 +906,18 @@ int HtmlGenerator::generateAtom(const Atom *atom, const Node *relative, CodeMark
             // ### Trenton
 
             QString t= protectEnc(plainCode(marker->markedUpEnumValue(atom->next()->string(),relative)));
-            out() << "<tr><td class=\"topAlign\"><tt>" << t << "</tt></td><td class=\"topAlign\">";
+            out() << "<tr><td class=\"topAlign\"><tt>" << t << "</tt>";
 
-            QString itemValue;
             if (relative->type() == Node::Enum) {
+                out() << "</td><td class=\"topAlign\">";
                 const EnumNode *enume = static_cast<const EnumNode *>(relative);
-                itemValue = enume->itemValue(atom->next()->string());
-            }
-
-            if (itemValue.isEmpty())
-                out() << '?';
-            else
-                out() << "<tt>" << protectEnc(itemValue) << "</tt>";
+                QString itemValue = enume->itemValue(atom->next()->string());
 
+                if (itemValue.isEmpty())
+                    out() << '?';
+                else
+                    out() << "<tt>" << protectEnc(itemValue) << "</tt>";
+            }
             skipAhead = 1;
         }
         break;
-- 
cgit v1.2.3