diff options
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput.webxml')
| -rw-r--r-- | tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput.webxml | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput.webxml b/tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput.webxml new file mode 100644 index 000000000..c09bbe31c --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/html/qdoctests-qdocfileoutput.webxml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="qdoctests-qdocfileoutput.html" href="qdoctests-qdocfileoutput.html" status="active" location="qdoctests-outputfromqdocfiles.qdoc" filepath="/home/levon/work/official/qttools/tests/auto/qdoc/generatedoutput/qdoctests-outputfromqdocfiles.qdoc" lineno="28" documented="true" subtype="page" title="Testing QDoc output from .qdoc files" fulltitle="Testing QDoc output from .qdoc files" subtitle="" module="Test" brief="This is a simple page for testing purposes only"> + <contents name="supported-file-types" title="Supported file types" level="1"/> + <contents name="further-information" title="Further information" level="1"/> + <contents name="linking" title="Linking" level="1"/> + <description path="/home/levon/work/official/qttools/tests/auto/qdoc/generatedoutput/qdoctests-outputfromqdocfiles.qdoc" line="28" column="4"> + <brief>This is a simple page for testing purposes only.</brief> + <para>QDoc generates documentation for software projects. It does this by extracting <italic>QDoc comments</italic> from project source files. QDoc comments are signified by a C-style-like comment tag followed by an exclamation point, like this: <teletype type="highlighted">/*!</teletype> <teletype type="highlighted">This text is contained within QDoc comment tags.</teletype> <teletype type="highlighted">*/</teletype>.</para> + <section id="supported-file-types"> + <heading level="1">Supported file types</heading> + <para>QDoc parses <teletype type="highlighted">.cpp</teletype> and <teletype type="highlighted">.qdoc</teletype> files. It does extract comments from header (<teletype type="highlighted">.h</teletype>) files.</para> + </section> + <section id="further-information"> + <heading level="1">Further information</heading> + <para>This test document is written with the purpose of testing the output QDoc generates when parsing <teletype type="highlighted">.qdoc</teletype> files. It is fairly simple and makes use of a limited subset of QDoc's command. Those commands are:</para> + <list type="bullet"> + <item> + <para> + <teletype type="highlighted">\page</teletype></para> + </item> + <item> + <para> + <teletype type="highlighted">\title</teletype></para> + </item> + <item> + <para> + <teletype type="highlighted">\brief</teletype></para> + </item> + <item> + <para> + <teletype type="highlighted">\e</teletype> (for emphasizing "QDoc comments")</para> + </item> + <item> + <para> + <teletype type="highlighted">\c</teletype> (for multiple monospace-formatted entries)</para> + </item> + <item> + <para> + <teletype type="highlighted">\section1</teletype></para> + </item> + <item> + <para> + <teletype type="highlighted">\list</teletype></para> + </item> + <item> + <para> + <teletype type="highlighted">\li</teletype></para> + </item> + <item> + <para> + <teletype type="highlighted">\endlist</teletype></para> + </item> + </list> + </section> + <section id="linking"> + <heading level="1">Linking</heading> + <para>There are multiple ways to create hyperlinks to other topics:</para> + <list type="bullet"> + <item> + <para> + <link raw="Testing QDoc's link command" href="qdoctests-qdocfileoutput-linking.html" type="page" page="Testing QDoc's link command">Linking to a page title</link></para> + </item> + <item> + <para> + <link raw="Link targets" href="qdoctests-qdocfileoutput-linking.html#link-targets" type="page" page="Testing QDoc's link command">Linking to a section title</link></para> + </item> + <item> + <para> + <link raw="link-test-target" href="qdoctests-qdocfileoutput-linking.html#link-test-target" type="page" page="Testing QDoc's link command">Linking using a \target string</link></para> + </item> + <item> + <para> + <link raw="QDoc Linking Test" href="qdoctests-qdocfileoutput-linking.html" type="page" page="Testing QDoc's link command">Linking using a \keyword string</link></para> + </item> + </list> + </section> + </description> + </page> + </document> +</WebXML> |