diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2022-11-07 11:06:41 +0100 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2022-11-18 09:21:23 +0000 |
| commit | b7849d42efff91a4d247a4028d6c129f3742743a (patch) | |
| tree | d73b6d16d55cd5c6ceafb780ca039291f60c18d6 /tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html | |
| parent | e62a46a1a6f332d4c22f19da393b818401a3f5b2 (diff) | |
qdoc: Add translate attribute to HTML blocks
A browser translates everything by default, which means
even the <code>, <pre>, <table>s listing the class members,
and so on, are also translated. With this change, such HTML
blocks will include the "translate=no" attribute, indicating
that they should not be translated.
Pick-to: 6.4 6.2 5.15
Fixes: QTBUG-106679
Done-with: Topi Reinio <topi.reinio@qt.io>
Change-Id: I446fe26c73b9e3fee2984297bd504ae72c555e73
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html')
| -rw-r--r-- | tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html index ef393e9c9..2ba3710a0 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html @@ -21,12 +21,12 @@ </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> -<h1 class="title">Test Class</h1> -<span class="small-subtitle">class <a href="testqdoc.html">TestQDoc</a>::Test</span> +<h1 class="title" translate="no">Test Class</h1> +<span class="small-subtitle" translate="no">class <a href="testqdoc.html">TestQDoc</a>::Test</span> <!-- $$$Test-brief --> <p>A class in a namespace. <a href="#details">More...</a></p> <!-- @@@Test --> -<div class="table"><table class="alignedsummary"> +<div class="table"><table class="alignedsummary" translate="no"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Test></span></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> @@ -41,11 +41,11 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> <li>Test is part of <a href="cpptypes.html">Test C++ Types</a>.</li> </ul> <h2 id="public-types">Public Types</h2> -<div class="table"><table class="alignedsummary"> +<div class="table"><table class="alignedsummary" translate="no"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#SomeType-typedef">SomeType</a></b></td></tr> </table></div> <h2 id="public-functions">Public Functions</h2> -<div class="table"><table class="alignedsummary"> +<div class="table"><table class="alignedsummary" translate="no"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#Test">Test</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void (*)(bool) </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#funcPtr">funcPtr</a></b>(bool <i>b</i>, const char *<i>s</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#inlineFunction">inlineFunction</a></b>()</td></tr> @@ -57,16 +57,16 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq">operator=</a></b>(TestQDoc::Test &&<i>other</i>)</td></tr> </table></div> <h2 id="protected-functions">Protected Functions</h2> -<div class="table"><table class="alignedsummary"> +<div class="table"><table class="alignedsummary" translate="no"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload">overload</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1">overload</a></b>(bool <i>b</i>)</td></tr> </table></div> <h2 id="related-non-members">Related Non-Members</h2> -<div class="table"><table class="alignedsummary"> +<div class="table"><table class="alignedsummary" translate="no"> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> </table></div> <h2 id="macros">Macros</h2> -<div class="table"><table class="alignedsummary"> +<div class="table"><table class="alignedsummary" translate="no"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#QDOCTEST_MACRO2">QDOCTEST_MACRO2</a></b>(int &<i>x</i>)</td></tr> </table></div> <!-- $$$Test-description --> @@ -77,7 +77,7 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$SomeType --> -<h3 class="fn" id="SomeType-typedef">Test::<span class="name">SomeType</span></h3> +<h3 class="fn" translate="no" id="SomeType-typedef">Test::<span class="name">SomeType</span></h3> <p>A typedef.</p> <!-- @@@SomeType --> </div> @@ -85,35 +85,35 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> <h2>Member Function Documentation</h2> <!-- $$$ --> <div class="fngroup"> -<h3 class="fn fngroupitem" id="overload"><code>[protected] </code><span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" id="overload-1"><code>[protected, since Test 1.2] </code><span class="type">void</span> Test::<span class="name">overload</span>(<span class="type">bool</span> <i>b</i>)</h3></div> -<p>Overloads that share a documentation comment, optionally taking a parameter <i>b</i>.</p> +<h3 class="fn fngroupitem" translate="no" id="overload"><code translate="no">[protected] </code><span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" translate="no" id="overload-1"><code translate="no">[protected, since Test 1.2] </code><span class="type">void</span> Test::<span class="name">overload</span>(<span class="type">bool</span> <i>b</i>)</h3></div> +<p>Overloads that share a documentation comment, optionally taking a parameter <i translate="no">b</i>.</p> <!-- @@@ --> <!-- $$$Test[overload1]$$$Test --> -<h3 class="fn" id="Test"><code>[default] </code>Test::<span class="name">Test</span>()</h3> +<h3 class="fn" translate="no" id="Test"><code translate="no">[default] </code>Test::<span class="name">Test</span>()</h3> <p>Default constructor.</p> <!-- @@@Test --> <!-- $$$funcPtr[overload1]$$$funcPtrboolconstchar* --> -<h3 class="fn" id="funcPtr"><span class="type">void</span> (*)(<span class="type">bool</span>) Test::<span class="name">funcPtr</span>(<span class="type">bool</span> <i>b</i>, const <span class="type">char</span> *<i>s</i>)</h3> -<p>Returns a pointer to a function that takes a boolean. Uses <i>b</i> and <i>s</i>.</p> +<h3 class="fn" translate="no" id="funcPtr"><span class="type">void</span> (*)(<span class="type">bool</span>) Test::<span class="name">funcPtr</span>(<span class="type">bool</span> <i>b</i>, const <span class="type">char</span> *<i>s</i>)</h3> +<p>Returns a pointer to a function that takes a boolean. Uses <i translate="no">b</i> and <i translate="no">s</i>.</p> <!-- @@@funcPtr --> <!-- $$$inlineFunction[overload1]$$$inlineFunction --> -<h3 class="fn" id="inlineFunction"><span class="type">void</span> Test::<span class="name">inlineFunction</span>()</h3> +<h3 class="fn" translate="no" id="inlineFunction"><span class="type">void</span> Test::<span class="name">inlineFunction</span>()</h3> <p>An inline function, documented using the \fn QDoc command.</p> <!-- @@@inlineFunction --> <!-- $$$methodWithEmDashInItsDocs[overload1]$$$methodWithEmDashInItsDocs --> -<h3 class="fn" id="methodWithEmDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEmDashInItsDocs</span>()</h3> -<p>This method has em dashes in its documentation—as you'll find represented by <code>---</code> in the sources—here and there. The important bit to note is that when passed e.g. to the \c command, the three hyphens are processed as input to the command and not replaced by an em dash.</p> +<h3 class="fn" translate="no" id="methodWithEmDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEmDashInItsDocs</span>()</h3> +<p>This method has em dashes in its documentation—as you'll find represented by <code translate="no">---</code> in the sources—here and there. The important bit to note is that when passed e.g. to the \c command, the three hyphens are processed as input to the command and not replaced by an em dash.</p> <p>-----------------------------------------------------------------------</p> <p>People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.</p> <p>—You can also start a new paragraph with an em dash, if you want to.</p> <p><b>See also </b><a href="testqdoc-test.html#methodWithEnDashInItsDocs">methodWithEnDashInItsDocs</a>.</p> <!-- @@@methodWithEmDashInItsDocs --> <!-- $$$methodWithEnDashInItsDocs[overload1]$$$methodWithEnDashInItsDocs --> -<h3 class="fn" id="methodWithEnDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEnDashInItsDocs</span>()</h3> -<p>This method has en dashes in its documentation – as you'll find represented by <code>--</code> in the sources – here and there. The important bit to note is that when passed e.g. to the \c command, the two hyphens are processed as input to the command and not replaced by an en dash. This also applies to code blocks, where otherwise, the decrement operator would get completely borked:</p> -<pre class="cpp"><span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">42</span>; i <span class="operator">></span> <span class="number">0</span>; <span class="operator">-</span><span class="operator">-</span>i) +<h3 class="fn" translate="no" id="methodWithEnDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEnDashInItsDocs</span>()</h3> +<p>This method has en dashes in its documentation – as you'll find represented by <code translate="no">--</code> in the sources – here and there. The important bit to note is that when passed e.g. to the \c command, the two hyphens are processed as input to the command and not replaced by an en dash. This also applies to code blocks, where otherwise, the decrement operator would get completely borked:</p> +<pre class="cpp" translate="no"><span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">42</span>; i <span class="operator">></span> <span class="number">0</span>; <span class="operator">-</span><span class="operator">-</span>i) <span class="comment">// Do something cool during countdown.</span></pre> -<p>...as it would be silly if this would output –i instead of <code>--i</code>.</p> +<p>...as it would be silly if this would output –i instead of <code translate="no">--i</code>.</p> <p>-----------------------------------------------------------------------</p> <p>It still allows people to add a bunch of dashes, though, without replacing them all with a series of en dashes. Of course, they might want to use the \hr command instead, like this:</p> <hr /> @@ -121,34 +121,34 @@ target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> <p><b>See also </b>methodWithEnDashInItsDocs.</p> <!-- @@@methodWithEnDashInItsDocs --> <!-- $$$someFunction[overload1]$$$someFunctionintint --> -<h3 class="fn" id="someFunction"><span class="type">int</span> Test::<span class="name">someFunction</span>(<span class="type">int</span>, <span class="type">int</span> <i>v</i> = 0)</h3> -<p>Function that takes a parameter <i>v</i>. Also returns the value of <i>v</i>.</p> +<h3 class="fn" translate="no" id="someFunction"><span class="type">int</span> Test::<span class="name">someFunction</span>(<span class="type">int</span>, <span class="type">int</span> <i>v</i> = 0)</h3> +<p>Function that takes a parameter <i translate="no">v</i>. Also returns the value of <i translate="no">v</i>.</p> <!-- @@@someFunction --> <!-- $$$someFunctionDefaultArg[overload1]$$$someFunctionDefaultArgintbool --> -<h3 class="fn" id="someFunctionDefaultArg"><span class="type">void</span> Test::<span class="name">someFunctionDefaultArg</span>(<span class="type">int</span> <i>i</i>, <span class="type">bool</span> <i>b</i> = false)</h3> -<p>Function that takes a parameter <i>i</i> and <i>b</i>.</p> +<h3 class="fn" translate="no" id="someFunctionDefaultArg"><span class="type">void</span> Test::<span class="name">someFunctionDefaultArg</span>(<span class="type">int</span> <i>i</i>, <span class="type">bool</span> <i>b</i> = false)</h3> +<p>Function that takes a parameter <i translate="no">i</i> and <i translate="no">b</i>.</p> <!-- @@@someFunctionDefaultArg --> <!-- $$$virtualFun[overload1]$$$virtualFun --> -<h3 class="fn" id="virtualFun"><code>[virtual] </code><span class="type">void</span> Test::<span class="name">virtualFun</span>()</h3> +<h3 class="fn" translate="no" id="virtualFun"><code translate="no">[virtual] </code><span class="type">void</span> Test::<span class="name">virtualFun</span>()</h3> <p>Function that must be reimplemented.</p> <!-- @@@virtualFun --> <!-- $$$operator=[overload1]$$$operator=TestQDoc::Test&& --> -<h3 class="fn" id="operator-eq"><code>[default] </code><span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &Test::<span class="name">operator=</span>(<span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &&<i>other</i>)</h3> -<p>Move-assigns <i>other</i>.</p> +<h3 class="fn" translate="no" id="operator-eq"><code translate="no">[default] </code><span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &Test::<span class="name">operator=</span>(<span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &&<i>other</i>)</h3> +<p>Move-assigns <i translate="no">other</i>.</p> <!-- @@@operator= --> </div> <div class="relnonmem"> <h2>Related Non-Members</h2> <!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> -<h3 class="fn" id="operator-eq-eq"><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> -<p>Returns true if <i>lhs</i> and <i>rhs</i> are equal.</p> +<h3 class="fn" translate="no" id="operator-eq-eq"><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i translate="no">lhs</i> and <i translate="no">rhs</i> are equal.</p> <!-- @@@operator== --> </div> <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> -<h3 class="fn" id="QDOCTEST_MACRO2"><code>[since Test 1.1] </code><span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> -<p>A macro with argument <i>x</i>.</p> +<h3 class="fn" translate="no" id="QDOCTEST_MACRO2"><code translate="no">[since Test 1.1] </code><span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> +<p>A macro with argument <i translate="no">x</i>.</p> <p>This macro was introduced in Test 1.1.</p> <!-- @@@QDOCTEST_MACRO2 --> </div> |