Skip to content

Commit 029a91c

Browse files
michaliskambimichaliskambi
committed
New autodoc
1 parent 9d6856c commit 029a91c

133 files changed

Lines changed: 41906 additions & 10227 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/autodoc/html/AllClasses.html‎

Lines changed: 76 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,61 @@
99

1010
<link rel="StyleSheet" type="text/css" href="bootstrap.min.css">
1111
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
12+
<style>
13+
.visibility-protected { display: none; }
14+
.inherited-member { display: none; }
15+
</style>
16+
<script>
17+
/* PasDoc JavaScript for toggleable visibility and/or inherited members. */
18+
19+
/* Get checkbox value, or true if the checkbox does not exist (e.g. for visibilities that are not toggable). */
20+
function getCheckboxValue(checkboxId) {
21+
var checkbox = document.getElementById(checkboxId);
22+
return checkbox ? checkbox.checked : true;
23+
}
24+
25+
/* Update display of members that are toggable because
26+
1. their visibility is toggable (--visible-members=xxx? in PasDoc)
27+
2. or they are from ancestors (inherited), and thus toggable (see --inherited-members in PasDoc)
28+
*/
29+
function pasdocUpdateMembers(className) {
30+
var elements = document.getElementsByClassName(className);
31+
var showInherited = getCheckboxValue("checkbox-inherited-member");
32+
var showVisibilities = {};
33+
showVisibilities["visibility-published"] = getCheckboxValue("checkbox-visibility-published");
34+
showVisibilities["visibility-public"] = getCheckboxValue("checkbox-visibility-public");
35+
showVisibilities["visibility-protected"] = getCheckboxValue("checkbox-visibility-protected");
36+
showVisibilities["visibility-strictprotected"] = getCheckboxValue("checkbox-visibility-strictprotected");
37+
showVisibilities["visibility-private"] = getCheckboxValue("checkbox-visibility-private");
38+
showVisibilities["visibility-strictprivate"] = getCheckboxValue("checkbox-visibility-strictprivate");
39+
showVisibilities["visibility-automated"] = getCheckboxValue("checkbox-visibility-automated");
40+
showVisibilities["visibility-implicit"] = getCheckboxValue("checkbox-visibility-implicit");
41+
for (var i = 0; i < elements.length; i++) {
42+
var show = true;
43+
if (elements[i].classList.contains("inherited-member")) {
44+
show = show && showInherited;
45+
}
46+
for (var visibility in showVisibilities) {
47+
if (elements[i].classList.contains(visibility)) {
48+
show = show && showVisibilities[visibility];
49+
break;
50+
}
51+
}
52+
elements[i].style.display = show ? "revert" : "none";
53+
}
54+
}
55+
</script>
1256
</head>
1357
<body>
14-
<nav class="navbar navbar-dark bg-dark d-md-none sticky-top">
58+
<nav class="navbar d-md-none sticky-top bg-body-tertiary">
1559
<div class="container-fluid">
1660
<a class="navbar-brand" href="index.html">PasDoc's autodoc</a>
1761
<button class="navbar-toggler" type="button" data-bs-toggle="offcanvas" data-bs-target="#sidebarNav" aria-controls="sidebarNav">
1862
<span class="navbar-toggler-icon"></span>
1963
</button>
2064
</div>
2165
</nav>
22-
<div class="offcanvas-md offcanvas-start navigation" tabindex="-1" id="sidebarNav">
66+
<div class="offcanvas-md offcanvas-start navigation" tabindex="-1" id="sidebarNav" data-bs-scroll="true">
2367
<div class="offcanvas-header">
2468
<h5 class="offcanvas-title">PasDoc's autodoc</h5>
2569
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#sidebarNav" aria-label="Close"></button>
@@ -108,6 +152,16 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
108152
<td class="itemdesc"><p>&nbsp;</p></td>
109153
</tr>
110154
<tr class="list">
155+
<td class="itemname"><a class="bold" href="PasDoc_Parser.TCioState.html">TCioState</a></td>
156+
<td class="itemunit"><a class="bold" href="PasDoc_Parser.html">PasDoc_Parser</a></td>
157+
<td class="itemdesc"><p>State of parsing a structure (called &quot;CIO&quot; throughout PasDoc codebase).</p></td>
158+
</tr>
159+
<tr class="list2">
160+
<td class="itemname"><a class="bold" href="PasDoc_Parser.TCioStateStack.html">TCioStateStack</a></td>
161+
<td class="itemunit"><a class="bold" href="PasDoc_Parser.html">PasDoc_Parser</a></td>
162+
<td class="itemdesc"><p>A stack of <a class="normal" href="PasDoc_Parser.TCioState.html">TCioState</a> objects currently used to parse nested classes and records.</p></td>
163+
</tr>
164+
<tr class="list">
111165
<td class="itemname"><a class="bold" href="PasDoc_Gen.TDocGenerator.html">TDocGenerator</a></td>
112166
<td class="itemunit"><a class="bold" href="PasDoc_Gen.html">PasDoc_Gen</a></td>
113167
<td class="itemdesc"><p>Base generator class, to be specialized for specific output formats.</p></td>
@@ -118,106 +172,76 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
118172
<td class="itemdesc"><p><code>TExternalItem</code> extends <a class="normal" href="PasDoc_Items.TBaseItem.html">TBaseItem</a> to store extra information about a project.</p></td>
119173
</tr>
120174
<tr class="list">
121-
<td class="itemname"><a class="bold" href="PasDoc_Items.TExternalItemList.html">TExternalItemList</a></td>
122-
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
123-
<td class="itemdesc"><p><code>TExternalItemList</code> extends <a class="normal" href="PasDoc_ObjectVector.TObjectVector.html">TObjectVector</a> to store non-nil instances of <a class="normal" href="PasDoc_Items.TExternalItem.html">TExternalItem</a></p></td>
124-
</tr>
125-
<tr class="list2">
126175
<td class="itemname"><a class="bold" href="PasDoc_GenHtml.TGenericHTMLDocGenerator.html">TGenericHTMLDocGenerator</a></td>
127176
<td class="itemunit"><a class="bold" href="PasDoc_GenHtml.html">PasDoc_GenHtml</a></td>
128177
<td class="itemdesc"><p>HTML documentation generator.</p></td>
129178
</tr>
130-
<tr class="list">
131-
<td class="itemname"><a class="bold" href="PasDoc_Hashes.THash.html">THash</a></td>
132-
<td class="itemunit"><a class="bold" href="PasDoc_Hashes.html">PasDoc_Hashes</a></td>
133-
<td class="itemdesc"><p>&nbsp;</p></td>
134-
</tr>
135179
<tr class="list2">
136-
<td class="itemname"><a class="bold" href="PasDoc_Hashes.THashEntry.html">THashEntry</a></td>
137-
<td class="itemunit"><a class="bold" href="PasDoc_Hashes.html">PasDoc_Hashes</a></td>
138-
<td class="itemdesc"><p>&nbsp;</p></td>
139-
</tr>
140-
<tr class="list">
141180
<td class="itemname"><a class="bold" href="PasDoc_GenHtml.THTMLDocGenerator.html">THTMLDocGenerator</a></td>
142181
<td class="itemunit"><a class="bold" href="PasDoc_GenHtml.html">PasDoc_GenHtml</a></td>
143182
<td class="itemdesc"><p>Right now this is the same thing as TGenericHTMLDocGenerator.</p></td>
144183
</tr>
145-
<tr class="list2">
184+
<tr class="list">
146185
<td class="itemname"><a class="bold" href="PasDoc_GenHtmlHelp.THTMLHelpDocGenerator.html">THTMLHelpDocGenerator</a></td>
147186
<td class="itemunit"><a class="bold" href="PasDoc_GenHtmlHelp.html">PasDoc_GenHtmlHelp</a></td>
148187
<td class="itemdesc"><p>&nbsp;</p></td>
149188
</tr>
150-
<tr class="list">
189+
<tr class="list2">
151190
<td class="itemname"><a class="bold" href="PasDoc_OptionParser.TIntegerOption.html">TIntegerOption</a></td>
152191
<td class="itemunit"><a class="bold" href="PasDoc_OptionParser.html">PasDoc_OptionParser</a></td>
153192
<td class="itemdesc"><p>Option that accepts additional Integer as a value.</p></td>
154193
</tr>
155-
<tr class="list2">
194+
<tr class="list">
156195
<td class="itemname"><a class="bold" href="PasDoc_Languages.TLanguageRecord.html">TLanguageRecord</a></td>
157196
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
158197
<td class="itemdesc"><p>&nbsp;</p></td>
159198
</tr>
160-
<tr class="list">
199+
<tr class="list2">
161200
<td class="itemname"><a class="bold" href="PasDoc_Gen.TListData.html">TListData</a></td>
162201
<td class="itemunit"><a class="bold" href="PasDoc_Gen.html">PasDoc_Gen</a></td>
163202
<td class="itemdesc"><p>Collected information about @xxxList content.</p></td>
164203
</tr>
165-
<tr class="list2">
204+
<tr class="list">
166205
<td class="itemname"><a class="bold" href="PasDoc_Gen.TListItemData.html">TListItemData</a></td>
167206
<td class="itemunit"><a class="bold" href="PasDoc_Gen.html">PasDoc_Gen</a></td>
168207
<td class="itemdesc"><p>Collected information about @xxxList item.</p></td>
169208
</tr>
170-
<tr class="list">
209+
<tr class="list2">
171210
<td class="itemname"><a class="bold" href="PasDoc_TagManager.TNonSelfTag.html">TNonSelfTag</a></td>
172211
<td class="itemunit"><a class="bold" href="PasDoc_TagManager.html">PasDoc_TagManager</a></td>
173212
<td class="itemdesc"><p>&nbsp;</p></td>
174213
</tr>
175-
<tr class="list2">
176-
<td class="itemname"><a class="bold" href="PasDoc_Hashes.TObjectHash.html">TObjectHash</a></td>
177-
<td class="itemunit"><a class="bold" href="PasDoc_Hashes.html">PasDoc_Hashes</a></td>
178-
<td class="itemdesc"><p>&nbsp;</p></td>
179-
</tr>
180214
<tr class="list">
181-
<td class="itemname"><a class="bold" href="PasDoc_ObjectVector.TObjectVector.html">TObjectVector</a></td>
182-
<td class="itemunit"><a class="bold" href="PasDoc_ObjectVector.html">PasDoc_ObjectVector</a></td>
183-
<td class="itemdesc"><p>&nbsp;</p></td>
184-
</tr>
185-
<tr class="list2">
186215
<td class="itemname"><a class="bold" href="PasDoc_OptionParser.TOption.html">TOption</a></td>
187216
<td class="itemunit"><a class="bold" href="PasDoc_OptionParser.html">PasDoc_OptionParser</a></td>
188217
<td class="itemdesc"><p>Base class for options.</p></td>
189218
</tr>
190-
<tr class="list">
219+
<tr class="list2">
191220
<td class="itemname"><a class="bold" href="PasDoc_OptionParser.TOptionParser.html">TOptionParser</a></td>
192221
<td class="itemunit"><a class="bold" href="PasDoc_OptionParser.html">PasDoc_OptionParser</a></td>
193222
<td class="itemdesc"><p>OptionParser &mdash; instantiate one of these for commandline parsing</p></td>
194223
</tr>
195-
<tr class="list2">
224+
<tr class="list">
196225
<td class="itemname"><a class="bold" href="PasDoc_Gen.TOverviewFileInfo.html">TOverviewFileInfo</a></td>
197226
<td class="itemunit"><a class="bold" href="PasDoc_Gen.html">PasDoc_Gen</a></td>
198227
<td class="itemdesc"><p>&nbsp;</p></td>
199228
</tr>
200-
<tr class="list">
229+
<tr class="list2">
201230
<td class="itemname"><a class="bold" href="PasDoc_Parser.TParser.html">TParser</a></td>
202231
<td class="itemunit"><a class="bold" href="PasDoc_Parser.html">PasDoc_Parser</a></td>
203232
<td class="itemdesc"><p>Parser class that will process a complete unit file and all of its include files, regarding directives.</p></td>
204233
</tr>
234+
<tr class="list">
235+
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasAliasType.html">TPasAliasType</a></td>
236+
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
237+
<td class="itemdesc"><p>Alias type</p></td>
238+
</tr>
205239
<tr class="list2">
206240
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasCio.html">TPasCio</a></td>
207241
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
208242
<td class="itemdesc"><p>Extends <a class="normal" href="PasDoc_Items.TPasItem.html">TPasItem</a> to store all items in a class / an object, e.g. fields.</p></td>
209243
</tr>
210244
<tr class="list">
211-
<td class="itemname"><a class="bold" href="PasDoc_Parser.TPasCioHelper.html">TPasCioHelper</a></td>
212-
<td class="itemunit"><a class="bold" href="PasDoc_Parser.html">PasDoc_Parser</a></td>
213-
<td class="itemdesc"><p><code>TPasCioHelper</code> stores a CIO reference and current state.</p></td>
214-
</tr>
215-
<tr class="list2">
216-
<td class="itemname"><a class="bold" href="PasDoc_Parser.TPasCioHelperStack.html">TPasCioHelperStack</a></td>
217-
<td class="itemunit"><a class="bold" href="PasDoc_Parser.html">PasDoc_Parser</a></td>
218-
<td class="itemdesc"><p>A stack of <a class="normal" href="PasDoc_Parser.TPasCioHelper.html">TPasCioHelper</a> objects currently used to parse nested classes and records</p></td>
219-
</tr>
220-
<tr class="list">
221245
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasConstant.html">TPasConstant</a></td>
222246
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
223247
<td class="itemdesc"><p>Pascal constant.</p></td>
@@ -240,7 +264,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
240264
<tr class="list">
241265
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasFieldVariable.html">TPasFieldVariable</a></td>
242266
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
243-
<td class="itemdesc"><p>Pascal global variable or field or nested constant of CIO.</p></td>
267+
<td class="itemdesc"><p>Global variable or a field in CIO.</p></td>
244268
</tr>
245269
<tr class="list2">
246270
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasItem.html">TPasItem</a></td>
@@ -260,7 +284,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
260284
<tr class="list">
261285
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasNestedCios.html">TPasNestedCios</a></td>
262286
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
263-
<td class="itemdesc"><p>Collection of classes / records / interfaces.</p></td>
287+
<td class="itemdesc"><p>Collection of CIOs (classes, records, interfaces...) nested in outer CIO.</p></td>
264288
</tr>
265289
<tr class="list2">
266290
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasProperties.html">TPasProperties</a></td>
@@ -298,7 +322,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
298322
<tr class="list">
299323
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasTypes.html">TPasTypes</a></td>
300324
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
301-
<td class="itemdesc"><p>Collection of types.</p></td>
325+
<td class="itemdesc"><p>List of types.</p></td>
302326
</tr>
303327
<tr class="list2">
304328
<td class="itemname"><a class="bold" href="PasDoc_Items.TPasUnit.html">TPasUnit</a></td>
@@ -355,7 +379,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
355379
<tr class="list2">
356380
<td class="itemname"><a class="bold" href="PasDoc_OptionParser.TSetOption.html">TSetOption</a></td>
357381
<td class="itemunit"><a class="bold" href="PasDoc_OptionParser.html">PasDoc_OptionParser</a></td>
358-
<td class="itemdesc"><p>useful for making a choice of things</p></td>
382+
<td class="itemdesc"><p>Option that allows to define a set.</p></td>
359383
</tr>
360384
<tr class="list">
361385
<td class="itemname"><a class="bold" href="PasDoc_GenSimpleXML.TSimpleXMLDocGenerator.html">TSimpleXMLDocGenerator</a></td>
@@ -365,7 +389,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
365389
<tr class="list2">
366390
<td class="itemname"><a class="bold" href="PasDoc_Aspell.TSpellingError.html">TSpellingError</a></td>
367391
<td class="itemunit"><a class="bold" href="PasDoc_Aspell.html">PasDoc_Aspell</a></td>
368-
<td class="itemdesc"><p>Single misspelling found by <a class="normal" href="PasDoc_Aspell.TAspellProcess.html#CheckString-string-TObjectVector-">TAspellProcess.CheckString</a>.</p></td>
392+
<td class="itemdesc"><p>Single misspelling found by <a class="normal" href="PasDoc_Aspell.TAspellProcess.html#CheckString-string-TSpellingErrorList-">TAspellProcess.CheckString</a>.</p></td>
369393
</tr>
370394
<tr class="list">
371395
<td class="itemname"><a class="bold" href="PasDoc_HierarchyTree.TStringCardinalTree.html">TStringCardinalTree</a></td>
@@ -415,7 +439,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
415439
<tr class="list2">
416440
<td class="itemname"><a class="bold" href="PasDoc_TagManager.TTagVector.html">TTagVector</a></td>
417441
<td class="itemunit"><a class="bold" href="PasDoc_TagManager.html">PasDoc_TagManager</a></td>
418-
<td class="itemdesc"><p>All Items of this list must be non-nil TTag objects.</p></td>
442+
<td class="itemdesc"><p>List of TTag objects (only non-nil).</p></td>
419443
</tr>
420444
<tr class="list">
421445
<td class="itemname"><a class="bold" href="PasDoc_GenLatex.TTexDocGenerator.html">TTexDocGenerator</a></td>

0 commit comments

Comments
 (0)