|
22 | 22 |
|
23 | 23 | <meta name="viewport" content="width=device-width, initial-scale=1"> |
24 | 24 | <meta name="theme-color" content="#157878"> |
25 | | - <link rel="stylesheet" href="/assets/css/style.css?v=a92f71a6a83686dd5cec968f49a28ccd1626f661"> |
| 25 | + <link rel="stylesheet" href="/assets/css/style.css?v=b56c76a091fccd5697365291748319e1f1540676"> |
26 | 26 | </head> |
27 | 27 | <body> |
28 | 28 | <div id="layout-container"> |
|
39 | 39 | <h1>Advanced Features</h1> |
40 | 40 |
|
41 | 41 |
|
42 | | - <div class="paragraph"> |
43 | | -<p>Summary of the most important non-obvious PasDoc features:</p> |
| 42 | + <div id="toc" class="toc"> |
| 43 | +<div id="toctitle">Table of Contents</div> |
| 44 | +<ul class="sectlevel1"> |
| 45 | +<li><a href="#_input">1. Input</a></li> |
| 46 | +<li><a href="#_output">2. Output</a></li> |
| 47 | +<li><a href="#_more">3. More</a></li> |
| 48 | +</ul> |
| 49 | +</div> |
| 50 | +<div id="preamble"> |
| 51 | +<div class="sectionbody"> |
| 52 | +<div class="paragraph"> |
| 53 | +<p>Some important non-obvious PasDoc features:</p> |
44 | 54 | </div> |
| 55 | +</div> |
| 56 | +</div> |
| 57 | +<div class="sect1"> |
| 58 | +<h2 id="_input">1. Input</h2> |
| 59 | +<div class="sectionbody"> |
45 | 60 | <div class="ulist"> |
46 | 61 | <ul> |
47 | 62 | <li> |
48 | | -<p>The documentation can be written in an external files (see the <a href="ReadDescriptionFromFile">--description</a> command-line option), not only in the source code.</p> |
| 63 | +<p><a href="AutoAbstractOption">--auto-abstract</a> command-line option allows you to automatically treat the 1st sentence of the description as an abstract.</p> |
49 | 64 | </li> |
50 | 65 | <li> |
51 | | -<p>The documentation comments in the source code may be in the <code>interface</code> or (if you use <a href="ImplementationCommentsOption">--implementation-comments</a> option) <code>implementation</code> section of the unit.</p> |
| 66 | +<p>You can write entire pages using pasdoc syntax, with all supported <a href="SupportedTags">@tags</a>. This way you can use pasdoc like a simple document creation tool. See the <a href="IntroductionAndConclusion">Introduction and conclusion</a> documentation.</p> |
52 | 67 | </li> |
53 | 68 | <li> |
54 | | -<p>The documentation can be localized to many languages, see the <a href="OutputLanguage">--language</a> command-line option.</p> |
| 69 | +<p>By default documentation is read from the source code comments. But you can also write it in separate external files: see the <a href="ReadDescriptionFromFile">--description</a> command-line option.</p> |
55 | 70 | </li> |
56 | 71 | <li> |
57 | | -<p>Support for arbitrary (even optional) <a href="CommentMarker">comment markers</a>.</p> |
| 72 | +<p>By default we consider only comments in the <code>interface</code> section of the unit. But you can enable parsing also the <code>implementation</code> sections, and using comments from it, using the <a href="ImplementationCommentsOption">--implementation-comments</a> option.</p> |
58 | 73 | </li> |
59 | 74 | <li> |
60 | | -<p>You can write entire pages using pasdoc syntax (like @-tags, see <a href="WritingDocumentation">WritingDocumentation</a>). This way you can use pasdoc like a simple document creation tool. See the <a href="IntroductionAndConclusion">IntroductionAndConclusion</a> documentation.</p> |
| 75 | +<p>By default every comment before an identifier is treated as a documentation. But you can limit this with arbitrary <a href="CommentMarker">comment markers</a>.</p> |
61 | 76 | </li> |
62 | 77 | <li> |
63 | | -<p>You can easily add a search box to your documentation, just pass <a href="UseTipueSearchOption">--use-tipue-search</a> command-line option.</p> |
| 78 | +<p><a href="AutoLinkOption">--auto-link</a> command-line option allows you to avoid writing so many <code>@link</code> tags. Identifiers will be automatically turned into links.</p> |
64 | 79 | </li> |
65 | 80 | <li> |
66 | | -<p><a href="GraphVizSupport">GraphVizSupport</a> allows PasDoc to easily incorporate classes inheritance and unit dependency graphs in the documentation.</p> |
| 81 | +<p><a href="MarkdownOption">Markdown support for emphasis, lists, code blocks etc.</a></p> |
67 | 82 | </li> |
| 83 | +</ul> |
| 84 | +</div> |
| 85 | +</div> |
| 86 | +</div> |
| 87 | +<div class="sect1"> |
| 88 | +<h2 id="_output">2. Output</h2> |
| 89 | +<div class="sectionbody"> |
| 90 | +<div class="ulist"> |
| 91 | +<ul> |
68 | 92 | <li> |
69 | | -<p><a href="AutoLinkOption">--auto-link</a> command-line option allows you to avoid writing @link tags, identifiers will be automatically turned into links.</p> |
| 93 | +<p>Our HTML output has a <a href="https://github.com/pasdoc/pasdoc/discussions/230">modern, mobile-friendly design based on Bootstrap</a>. You can customize it using <a href="CssOption">--css or --css-based-on-bootstrap</a> command-line options. You can also add your own HTML code to the output using <a href="HtmlHeadBodyBeginEndOptions">--html-head, --html-body-begin and --html-body-end</a> command-line options.</p> |
70 | 94 | </li> |
71 | 95 | <li> |
72 | | -<p><a href="AutoAbstractOption">--auto-abstract</a> command-line option allows you to automatically treat the 1st sentence of the description as an abstract.</p> |
| 96 | +<p>The documentation of each class can also include <a href="InheritedMembersOption">inherited members</a>.</p> |
| 97 | +</li> |
| 98 | +<li> |
| 99 | +<p>The documentation of each class can have toggable (using checkboxes in HTML) visibility e.g. for protected members. See <a href="VisibleMembers">--visible-members</a> command-line option.</p> |
| 100 | +</li> |
| 101 | +<li> |
| 102 | +<p>The documentation can point to the source code (file, line number) where given item is declared. It can even link to the online repository (e.g. GitHub) which is a great way to link people from your docs to your code. See the <a href="SourcePosition">--show-source-position, --source-url-pattern, --source-root</a> command-line options.</p> |
| 103 | +</li> |
| 104 | +<li> |
| 105 | +<p>You can easily add a search box to your documentation, just pass <a href="UseTipueSearchOption">--use-tipue-search</a> command-line option.</p> |
| 106 | +</li> |
| 107 | +<li> |
| 108 | +<p>The documentation can be localized to many languages, see the <a href="OutputLanguage">--language</a> command-line option.</p> |
| 109 | +</li> |
| 110 | +<li> |
| 111 | +<p><a href="GraphVizSupport">GraphVizSupport</a> allows PasDoc to easily incorporate classes inheritance and unit dependency graphs in the documentation.</p> |
73 | 112 | </li> |
74 | 113 | <li> |
75 | 114 | <p><a href="SpellChecking">Spell checking</a>.</p> |
76 | 115 | </li> |
| 116 | +</ul> |
| 117 | +</div> |
| 118 | +</div> |
| 119 | +</div> |
| 120 | +<div class="sect1"> |
| 121 | +<h2 id="_more">3. More</h2> |
| 122 | +<div class="sectionbody"> |
| 123 | +<div class="ulist"> |
| 124 | +<ul> |
77 | 125 | <li> |
78 | 126 | <p><a href="CacheOption">Caching for faster generation of documentation</a>.</p> |
79 | 127 | </li> |
80 | 128 | <li> |
81 | | -<p><a href="MarkdownOption">Markdown support for emphasis, lists, code blocks etc.</a></p> |
| 129 | +<p>See also <a href="PasDocFpDocComparison">comparison of PasDoc with FpDoc (another open-source Pascal documentation tool)</a>.</p> |
82 | 130 | </li> |
83 | 131 | </ul> |
84 | 132 | </div> |
85 | | -<div class="paragraph"> |
86 | | -<p>If you want to compare <a href="index">PasDoc</a> to FpDoc (another open-source Pascal documentation tool), see <a href="PasDocFpDocComparison">PasDocFpDocComparison</a> .</p> |
| 133 | +</div> |
87 | 134 | </div> |
88 | 135 |
|
89 | 136 | <footer class="site-footer"> |
@@ -293,6 +340,9 @@ <h2 id="command-line"><a href="CommandLine">Command Line</a>:</h2> |
293 | 340 | <li> |
294 | 341 | <p><a href="IgnoreMarkerOption">--ignore-marker</a></p> |
295 | 342 | </li> |
| 343 | + <li> |
| 344 | + <p><a href="InheritedMembersOption">--inherited-members</a></p> |
| 345 | + </li> |
296 | 346 | <li> |
297 | 347 | <p><a href="IntroductionAndConclusion">--introduction, --conclusion, -A, --additional</a></p> |
298 | 348 | </li> |
|
0 commit comments