qdoc: Fix output of \footnote command

These small changes make the output of \footnote slightly more sane.
The command is not fully implemented; for HTML generator it produces
only <!-- --> comments, but the previous behavior was incorrect and
affected formatting of the rest of the document.

With WebXML output format, \footnote command together with \link (as
in the generatedoutput test) seem to differ in linefeed placement on
Windows as compared to other platforms. Remove these from the tested
set for now.

Change-Id: Id387aaeef1de1d1a859b5ec6e388394564cd0732
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

4 files changed, 35 insertions, 55 deletions

diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoctests-qdocfileoutput-exhaustive.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoctests-qdocfileoutput-exhaustive.xml
index d664dd72e..af2fdd955 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoctests-qdocfileoutput-exhaustive.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/qdoctests-qdocfileoutput-exhaustive.xml
@@ -28,10 +28,6 @@
 <db:para>And if I knew qmltext, I guess this is where that would go. </db:para>
 <db:title>This a caption</db:title>
 <db:para>Lorem legal ipsum</db:para>
-<db:para><db:footnote>
-<db:para><db:para>This is where I put my footnotes.</db:para>
-</db:para>
-</db:footnote><db:para><db:link xlink:href="https://www.qt.io"/></db:para>
 <db:blockquote><db:para>This is a quotation.</db:para>
 </db:blockquote>
         &lt;html&gt;&lt;body&gt;This is &lt;b&gt;raw&lt;/b&gt;. Like the &lt;h1&gt;Eddie Murphy&lt;/h1&gt; movie. Just not as funny.&lt;/body&gt;&lt;/html&gt;
@@ -61,9 +57,9 @@
 <db:note>
 <db:para>The code above doesn't compile</db:para>
 </db:note>
-<db:para><db:emphasis role="bold">Warning:</db:emphasis> The following commands have yet to be tested: sincelist header index topicref // or just don’t care, remove it image inlineimage printline printto printuntil // what’s the difference between printto and printuntil??? quotefile quotefromfile quotefunction skipline skipto skipuntil span snippet codeline overload sub sup tableofcontents tt uicontrol endmapref endomit underline unicode</db:para>
-</db:para>
+<db:para><db:emphasis role="bold">Warning:</db:emphasis> The following commands have yet to be tested: footnote link sincelist header index topicref // or just don’t care, remove it image inlineimage printline printto printuntil // what’s the difference between printto and printuntil??? quotefile quotefromfile quotefunction skipline skipto skipuntil span snippet codeline overload sub sup tableofcontents tt uicontrol endmapref endomit underline unicode</db:para>
 </db:section>
 </db:section>
 </db:section>
-</db:section></db:article>
+</db:section>
+</db:article>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput-exhaustive.webxml b/tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput-exhaustive.webxml
index 147edc711..673675bd1 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput-exhaustive.webxml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput-exhaustive.webxml
@@ -31,40 +31,32 @@
     <para>And if I knew qmltext, I guess this is where that would go. </para>This a caption<legalese>
         <para>Lorem legal ipsum</para>
     </legalese>
-    <para>
-        <footnote>
-            <para>This is where I put my footnotes.</para>
-        </footnote>
-        <para>
-            <link raw="https://www.qt.io" href="https://www.qt.io" type="external"/>
-        </para>
-        <quote>
-            <para>This is a quotation.</para>
-        </quote>
-        <raw format="HTML">        &lt;html&gt;&lt;body&gt;This is &lt;b&gt;raw&lt;/b&gt;. Like the &lt;h1&gt;Eddie Murphy&lt;/h1&gt; movie. Just not as funny.&lt;/body&gt;&lt;/html&gt;
+    <quote>
+        <para>This is a quotation.</para>
+    </quote>
+    <raw format="HTML">        &lt;html&gt;&lt;body&gt;This is &lt;b&gt;raw&lt;/b&gt;. Like the &lt;h1&gt;Eddie Murphy&lt;/h1&gt; movie. Just not as funny.&lt;/body&gt;&lt;/html&gt;
     </raw>
-        <para>Look, ma! I made a sidebar!</para>
-        <table>
-            <row>
-                <item>
-                    <para>Table item in a table row</para>
-                </item>
-            </row>
-            <row>
-                <item>
-                    <para>Another item in a different row</para>
-                </item>
-            </row>
-        </table>
-        <para>
-            <bold>Important:</bold> This is really important.</para>
-        <para>For example, if you have code like</para>
-        <oldcode>This is old code.</oldcode>
-        <para>you can rewrite it as</para>
-        <newcode>This is new and shiny!</newcode>
-        <para>
-            <bold>Note:</bold> The code above doesn't compile</para>
-        <para>
-            <bold>Warning:</bold> The following commands have yet to be tested: sincelist header index topicref // or just don’t care, remove it image inlineimage printline printto printuntil // what’s the difference between printto and printuntil??? quotefile quotefromfile quotefunction skipline skipto skipuntil span snippet codeline overload sub sup tableofcontents tt uicontrol endmapref endomit underline unicode</para>
-    </para>
+    <para>Look, ma! I made a sidebar!</para>
+    <table>
+        <row>
+            <item>
+                <para>Table item in a table row</para>
+            </item>
+        </row>
+        <row>
+            <item>
+                <para>Another item in a different row</para>
+            </item>
+        </row>
+    </table>
+    <para>
+        <bold>Important:</bold> This is really important.</para>
+    <para>For example, if you have code like</para>
+    <oldcode>This is old code.</oldcode>
+    <para>you can rewrite it as</para>
+    <newcode>This is new and shiny!</newcode>
+    <para>
+        <bold>Note:</bold> The code above doesn't compile</para>
+    <para>
+        <bold>Warning:</bold> The following commands have yet to be tested: footnote link sincelist header index topicref // or just don’t care, remove it image inlineimage printline printto printuntil // what’s the difference between printto and printuntil??? quotefile quotefromfile quotefunction skipline skipto skipuntil span snippet codeline overload sub sup tableofcontents tt uicontrol endmapref endomit underline unicode</para>
 </WebXML>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qdoctests-qdocfileoutput-exhaustive.html b/tests/auto/qdoc/generatedoutput/expected_output/qdoctests-qdocfileoutput-exhaustive.html
index 0600e8e1e..8dcfe9452 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/qdoctests-qdocfileoutput-exhaustive.html
+++ b/tests/auto/qdoc/generatedoutput/expected_output/qdoctests-qdocfileoutput-exhaustive.html
@@ -39,10 +39,7 @@
 <p>And if I knew qmltext, I guess this is where that would go. </p>
 <p class="figCaption">This a caption</p>
 <div class="LegaleseLeft"><p>Lorem legal ipsum</p>
-</div><p></p>
-<!-- <p>This is where I put my footnotes.</p>
---><p><a href="https://www.qt.io"></a></p>
-<blockquote><p>This is a quotation.</p>
+</div><blockquote><p>This is a quotation.</p>
 </blockquote>
         <html><body>This is <b>raw</b>. Like the <h1>Eddie Murphy</h1> movie. Just not as funny.</body></html>
     <p>Look, ma! I made a sidebar!</p>
@@ -56,7 +53,7 @@
 <pre class="cpp">This is <span class="keyword">new</span> and shiny<span class="operator">!</span></pre>
 <p><b>Note: </b>The code above doesn't compile</p>
 <hr />
-<p><b>Warning:</b> The following commands have yet to be tested: sincelist header index topicref // or just don’t care, remove it image inlineimage printline printto printuntil // what’s the difference between printto and printuntil??? quotefile quotefromfile quotefunction skipline skipto skipuntil span snippet codeline overload sub sup tableofcontents tt uicontrol endmapref endomit underline unicode</p>
+<p><b>Warning:</b> The following commands have yet to be tested: footnote link sincelist header index topicref // or just don’t care, remove it image inlineimage printline printto printuntil // what’s the difference between printto and printuntil??? quotefile quotefromfile quotefunction skipline skipto skipuntil span snippet codeline overload sub sup tableofcontents tt uicontrol endmapref endomit underline unicode</p>
 </div>
 <!-- @@@qdoctests-qdocfileoutput-exhaustive.html -->
 </body>
diff --git a/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc
index c17a5810b..e421ed1fb 100644
--- a/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc
+++ b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc
@@ -145,14 +145,6 @@
         Lorem legal ipsum
     \endlegalese
 
-    \footnote
-    This is where I put my footnotes.
-    \endfootnote
-
-    \link 
-        https://www.qt.io
-    \endlink
-
     \quotation
     This is a quotation.
     \endquotation
@@ -185,6 +177,9 @@
     \hr
 
     \warning The following commands have yet to be tested:
+    footnote
+    link
+    //! Check why above two (when used in this order) cause missing linefeeds on Windows/webxml
     sincelist
     header
     index