diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-12-13 23:32:44 +0100 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2019-12-16 12:34:04 +0100 |
commit | 5aa19d92036be3056ee7ff2d5d302b52a3e4a394 (patch) | |
tree | 3a1df24cc52b63583c24aa8575c703171d6e5109 /tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html | |
parent | 54ba8c725517fd3651d8949473a155329def62e7 (diff) |
qdoc: Fix regression in output for QML properties with shared comments
QDoc was incorrectly assuming that QML properties that share a comment
must belong to a property group.
Fix the issue, reduce duplication of code with functions that
output properties and methods, fix the 'id' attributes that were left
empty, and remove the <a name="..."> elements that are obsolete and
unnecessary now that 'id' has correct content.
Add a test for both properties and methods that share a comment, and
fix the expected output data for above changes.
Fixes: QTBUG-80768
Change-Id: Iddfca8214b6058987c76cd8f8dd6a842ce7cea89
Reviewed-by: Levon Sargsyan <levon.sargsyan@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html')
-rw-r--r-- | tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html | 95 |
1 files changed, 70 insertions, 25 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html index 8bd343fa1..30c48adf5 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/qml-qdoc-test-type.html @@ -32,6 +32,8 @@ <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#fifth-prop">fifth</a></b></b> : int</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#fourth-prop">fourth</a></b></b> : int</li> <li class="fn"><b><b><a href="qml-qdoc-test-type.html#group-prop">group</a></b></b><ul> <li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.first-prop">group.first</a></b></b> : int</li> <li class="fn"><b><b><a href="qml-qdoc-test-type.html#group.second-prop">group.second</a></b></b> : int</li> @@ -60,45 +62,74 @@ <h2 id="methods">Methods</h2> <ul> <li class="fn">Type <b><b><a href="qml-qdoc-test-type.html#copy-method">copy</a></b></b>(<i>a</i>)</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#disable-method">disable</a></b></b>()</li> +<li class="fn"><b><b><a href="qml-qdoc-test-type.html#enable-method">enable</a></b></b>()</li> </ul> <!-- $$$Type-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <!-- @@@Type --> <h2>Property Documentation</h2> +<!-- $$$ --> +<div class="qmlitem"><div class="fngroup"> +<div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="fourth-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">fourth</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="fifth-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">fifth</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +</table></div></div> +</div><div class="qmldoc"><p>A group of properties sharing a documentation comment.</p> +</div></div><!-- @@@ --> +<br/> <!-- $$$group --> -<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="even" id="group-prop"><th class="centerAlign"><p><a name="group-prop"></a><b>group group</b></p></th></tr><tr valign="top" class="odd" id="group.first-prop"><td class="tblQmlPropNode"><p><a name="group.first-prop"></a><span class="name">group.first</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr><tr valign="top" class="odd" id="group.second-prop"><td class="tblQmlPropNode"><p><a name="group.second-prop"></a><span class="name">group.second</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr><tr valign="top" class="odd" id="group.third-prop"><td class="tblQmlPropNode"><p><a name="group.third-prop"></a><span class="name">group.third</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>A property group.</p> +<div class="qmlitem"><div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="even" id="group-prop"><th class="centerAlign"><p><b>group group</b></p></th></tr> +<tr valign="top" class="odd" id="group.first-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.first</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="group.second-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.second</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="group.third-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.third</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>A property group.</p> </div></div><!-- @@@group --> <br/> <!-- $$$id --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> -<tr valign="top" class="odd" id=""> +<tr valign="top" class="odd" id="id-prop"> <td class="tblQmlPropNode"><p> -<a name="id-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">id</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> -</table></div> -</div><div class="qmldoc"><p>A read-only property.</p> +<span class="qmlreadonly">[read-only] </span><span class="name">id</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>A read-only property.</p> </div></div><!-- @@@id --> <br/> <!-- $$$name --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> -<tr valign="top" class="odd" id=""> +<tr valign="top" class="odd" id="name-prop"> <td class="tblQmlPropNode"><p> -<a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr> -</table></div> -</div><div class="qmldoc"><p>Name of the Test.</p> +<span class="name">name</span> : <span class="type">string</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Name of the Test.</p> </div></div><!-- @@@name --> <br/> <h2>Attached Property Documentation</h2> <!-- $$$type --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> -<tr valign="top" class="odd" id=""> +<tr valign="top" class="odd" id="type-attached-prop"> <td class="tblQmlPropNode"><p> -<a name="type-attached-prop"></a><span class="name">Type.type</span> : <span class="type">enumeration</span></p></td></tr> -</table></div> -</div><div class="qmldoc"><div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> +<span class="name">Type.type</span> : <span class="type">enumeration</span></p></td></tr> +</table></div></div> +<div class="qmldoc"><div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Type.NoType</code></td><td class="topAlign">Nothing</td></tr> <tr><td class="topAlign"><code>Type.SomeType</code></td><td class="topAlign">Something</td></tr> </table></div> @@ -108,33 +139,47 @@ <!-- $$$completed[overload1]$$$completed --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> -<tr valign="top" class="odd" id=""> +<tr valign="top" class="odd" id="completed-signal"> <td class="tblQmlFuncNode"><p> -<a name="completed-signal"></a><span class="name">completed</span>(<i>status</i>)</p></td></tr> -</table></div> -</div><div class="qmldoc"><p>This signal is emitted when the operation completed with <i>status</i>.</p> +<span class="name">completed</span>(<i>status</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This signal is emitted when the operation completed with <i>status</i>.</p> </div></div><!-- @@@completed --> <br/> <h2>Attached Signal Documentation</h2> <!-- $$$configured[overload1]$$$configured --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> -<tr valign="top" class="odd" id=""> +<tr valign="top" class="odd" id="configured-signal"> <td class="tblQmlFuncNode"><p> -<a name="configured-signal"></a><span class="name">configured</span>()</p></td></tr> -</table></div> -</div><div class="qmldoc"><p>This attached signal is emitted when the type was configured.</p> +<span class="name">configured</span>()</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>This attached signal is emitted when the type was configured.</p> </div></div><!-- @@@configured --> <br/> <h2>Method Documentation</h2> +<!-- $$$ --> +<div class="qmlitem"><div class="fngroup"> +<div class="qmlproto"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="enable-method"> +<td class="tblQmlFuncNode"><p> +<span class="name">enable</span>()</p></td></tr> +<tr valign="top" class="odd" id="disable-method"> +<td class="tblQmlFuncNode"><p> +<span class="name">disable</span>()</p></td></tr> +</table></div></div> +</div><div class="qmldoc"><p>Enables or disables this type.</p> +</div></div><!-- @@@ --> +<br/> <!-- $$$copy[overload1]$$$copy --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> -<tr valign="top" class="odd" id=""> +<tr valign="top" class="odd" id="copy-method"> <td class="tblQmlFuncNode"><p> -<a name="copy-method"></a><span class="type"><a href="qml-qdoc-test-type.html">Type</a></span> <span class="name">copy</span>(<i>a</i>)</p></td></tr> -</table></div> -</div><div class="qmldoc"><p>Returns another Type based on <i>a</i>.</p> +<span class="type"><a href="qml-qdoc-test-type.html">Type</a></span> <span class="name">copy</span>(<i>a</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Returns another Type based on <i>a</i>.</p> </div></div><!-- @@@copy --> <br/> </body> |