/usr/share/qt5/doc/qdoc/qdoc-guide.html is in qttools5-doc-html 5.9.5-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdoc-guide.qdoc -->
<title>Getting Started with QDoc | QDoc Manual 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Getting Started with QDoc</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<link rel="next" href="qdoc-guide-conf.html" />
<p class="naviNextPrevious headerNavi">
<a class="nextPage" href="qdoc-guide-conf.html">Creating QDoc Configuration Files</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#chapters">Chapters</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Getting Started with QDoc</h1>
<span class="subtitle"></span>
<!-- $$$qdoc-guide.html-description -->
<div class="descr"> <a name="details"></a>
<p>Qt uses QDoc to generate its documentation set into HTML and DITA XML formats. QDoc uses a set of configuration files to generate documentation from QDoc comments. The comments have types called <a href="qdoc-guide-writing.html#writing-topic-commands">topics</a> that determine whether a comment is a class documentation or a property documentation. A comment may also have <a href="qdoc-guide-writing.html#writing-markup">mark up</a> to enhance the layout and formatting of the final output.</p>
<p>There are three essential materials for generating documentation with qdoc:</p>
<ul>
<li><code>QDoc</code> binary</li>
<li><code>qdocconf</code> configuration files</li>
<li><code>Documentation</code> in <code>C++</code>, <code>QML</code>, and <code>.qdoc</code> files</li>
</ul>
<p>This section intends to cover the basic necessities for creating a documentation set. Additionally, the guide presents special considerations and options to documenting non-C++ API documentation as well as QML documentation. Finally, the guide will provide a sample project documentation and an example of a QML type documentation.</p>
<p>For specific QDoc information, consult the <a href="qdoc-index.html">QDoc Manual</a>.</p>
<a name="chapters"></a>
<h2 id="chapters">Chapters</h2>
<ol class="1" type="1"><li><a href="qdoc-guide-conf.html">Creating QDoc Configuration Files</a></li>
<li><a href="qdoc-guide-writing.html">Writing Documentation</a></li>
<li><a href="qdoc-categories.html">Categories of Documentation</a><ul>
<li><a href="qtwritingstyle-cpp.html">C++ Documentation Style</a></li>
<li><a href="qtwritingstyle-qml.html">QML Documentation Style</a></li>
</ul>
</li>
<li><a href="qdoc-componentset-example.html">QML Documentation Example</a></li>
</ol>
</div>
<!-- @@@qdoc-guide.html -->
<p class="naviNextPrevious footerNavi">
<a class="nextPage" href="qdoc-guide-conf.html">Creating QDoc Configuration Files</a>
</p>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|