Skip to content

Commit 5cac55d

Browse files
committed
Updated autodoc
1 parent 93420c3 commit 5cac55d

119 files changed

Lines changed: 4663 additions & 10984 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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<title>PasDoc's autodoc: All Classes, Interfaces, Objects and Records</title>
55
<meta name="viewport" content="width=device-width, initial-scale=1">
6-
<meta name="generator" content="PasDoc 0.17.0.snapshot">
6+
<meta name="generator" content="PasDoc 1.0.0">
77
<meta http-equiv="content-type" content="text/html; charset=utf-8">
88
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
99

@@ -472,7 +472,7 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
472472
<td class="itemdesc"><p>Base class for all options that have values.</p></td>
473473
</tr>
474474
</table>
475-
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.17.0.snapshot</a>. </em>
475+
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 1.0.0</a>. </em>
476476
</span>
477477
</div></main>
478478
<script src="bootstrap.bundle.min.js"></script>

docs/autodoc/html/AllConstants.html

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<title>PasDoc's autodoc: All Constants</title>
55
<meta name="viewport" content="width=device-width, initial-scale=1">
6-
<meta name="generator" content="PasDoc 0.17.0.snapshot">
6+
<meta name="generator" content="PasDoc 1.0.0">
77
<meta http-equiv="content-type" content="text/html; charset=utf-8">
88
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
99

@@ -177,112 +177,107 @@ <h1 class="allitems">All Constants</h1>
177177
<td class="itemdesc"><p>all Object Pascal keywords</p></td>
178178
</tr>
179179
<tr class="list2">
180-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#lgDefault">lgDefault</a></td>
181-
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
182-
<td class="itemdesc"><p>&nbsp;</p></td>
183-
</tr>
184-
<tr class="list">
185180
<td class="itemname"><a class="bold" href="PasDoc_Gen.html#LowCreatedOverviewFile">LowCreatedOverviewFile</a></td>
186181
<td class="itemunit"><a class="bold" href="PasDoc_Gen.html">PasDoc_Gen</a></td>
187182
<td class="itemdesc"><p>Using High(TCreatedOverviewFile) or High(Overview) where Overview: TCreatedOverviewFile in PasDoc_GenHtml produces internal error in FPC 2.0.0.</p></td>
188183
</tr>
189-
<tr class="list2">
184+
<tr class="list">
190185
<td class="itemname"><a class="bold" href="PasDoc_Scanner.html#MAX_TOKENIZERS">MAX_TOKENIZERS</a></td>
191186
<td class="itemunit"><a class="bold" href="PasDoc_Scanner.html">PasDoc_Scanner</a></td>
192187
<td class="itemdesc"><p>maximum number of streams we can recurse into; first one is the unit stream, any other stream an include file; current value is 32, increase this if you have more include files recursively including others</p></td>
193188
</tr>
194-
<tr class="list">
189+
<tr class="list2">
195190
<td class="itemname"><a class="bold" href="PasDoc_OptionParser.html#OptionFileChar">OptionFileChar</a></td>
196191
<td class="itemunit"><a class="bold" href="PasDoc_OptionParser.html">PasDoc_OptionParser</a></td>
197192
<td class="itemdesc"><p>Marks &quot;include config file&quot; option</p></td>
198193
</tr>
199-
<tr class="list2">
194+
<tr class="list">
200195
<td class="itemname"><a class="bold" href="PasDoc_OptionParser.html#OptionIndent">OptionIndent</a></td>
201196
<td class="itemunit"><a class="bold" href="PasDoc_OptionParser.html">PasDoc_OptionParser</a></td>
202197
<td class="itemdesc"><p>Indentation of option's name from the start of console line</p></td>
203198
</tr>
204-
<tr class="list">
199+
<tr class="list2">
205200
<td class="itemname"><a class="bold" href="PasDoc_OptionParser.html#OptionSep">OptionSep</a></td>
206201
<td class="itemunit"><a class="bold" href="PasDoc_OptionParser.html">PasDoc_OptionParser</a></td>
207202
<td class="itemdesc"><p>Separator between option's name and explanation</p></td>
208203
</tr>
209-
<tr class="list2">
204+
<tr class="list">
210205
<td class="itemname"><a class="bold" href="PasDoc_Gen.html#OverviewFilesInfo">OverviewFilesInfo</a></td>
211206
<td class="itemunit"><a class="bold" href="PasDoc_Gen.html">PasDoc_Gen</a></td>
212207
<td class="itemdesc"><p>&nbsp;</p></td>
213208
</tr>
214-
<tr class="list">
209+
<tr class="list2">
215210
<td class="itemname"><a class="bold" href="PasDoc_Versions.html#PASDOC_DATE">PASDOC_DATE</a></td>
216211
<td class="itemunit"><a class="bold" href="PasDoc_Versions.html">PasDoc_Versions</a></td>
217-
<td class="itemdesc"><p>PASDOC_DATE = '2021-02-07';</p></td>
212+
<td class="itemdesc"><p>Date of this pasdoc release, for stable releases.</p></td>
218213
</tr>
219-
<tr class="list2">
214+
<tr class="list">
220215
<td class="itemname"><a class="bold" href="PasDoc_Versions.html#PASDOC_HOMEPAGE">PASDOC_HOMEPAGE</a></td>
221216
<td class="itemunit"><a class="bold" href="PasDoc_Versions.html">PasDoc_Versions</a></td>
222217
<td class="itemdesc"><p>&nbsp;</p></td>
223218
</tr>
224-
<tr class="list">
219+
<tr class="list2">
225220
<td class="itemname"><a class="bold" href="PasDoc_Versions.html#PASDOC_NAME">PASDOC_NAME</a></td>
226221
<td class="itemunit"><a class="bold" href="PasDoc_Versions.html">PasDoc_Versions</a></td>
227222
<td class="itemdesc"><p>&nbsp;</p></td>
228223
</tr>
229-
<tr class="list2">
224+
<tr class="list">
230225
<td class="itemname"><a class="bold" href="PasDoc_Versions.html#PASDOC_NAME_AND_VERSION">PASDOC_NAME_AND_VERSION</a></td>
231226
<td class="itemunit"><a class="bold" href="PasDoc_Versions.html">PasDoc_Versions</a></td>
232227
<td class="itemdesc"><p>&nbsp;</p></td>
233228
</tr>
234-
<tr class="list">
229+
<tr class="list2">
235230
<td class="itemname"><a class="bold" href="PasDoc_Versions.html#PASDOC_VERSION">PASDOC_VERSION</a></td>
236231
<td class="itemunit"><a class="bold" href="PasDoc_Versions.html">PasDoc_Versions</a></td>
237-
<td class="itemdesc"><p>&nbsp;</p></td>
232+
<td class="itemdesc"><p>PASDOC_VERSION = '0.17.0.snapshot';</p></td>
238233
</tr>
239-
<tr class="list2">
234+
<tr class="list">
240235
<td class="itemname"><a class="bold" href="PasDoc_SortSettings.html#SortSettingNames">SortSettingNames</a></td>
241236
<td class="itemunit"><a class="bold" href="PasDoc_SortSettings.html">PasDoc_SortSettings</a></td>
242237
<td class="itemdesc"><p>Must be lowercase.</p></td>
243238
</tr>
244-
<tr class="list">
239+
<tr class="list2">
245240
<td class="itemname"><a class="bold" href="PasDoc_Tokenizer.html#StandardDirectiveArray">StandardDirectiveArray</a></td>
246241
<td class="itemunit"><a class="bold" href="PasDoc_Tokenizer.html">PasDoc_Tokenizer</a></td>
247242
<td class="itemdesc"><p>Object Pascal directives</p></td>
248243
</tr>
249-
<tr class="list2">
244+
<tr class="list">
250245
<td class="itemname"><a class="bold" href="PasDoc_Tokenizer.html#SymbolNames">SymbolNames</a></td>
251246
<td class="itemunit"><a class="bold" href="PasDoc_Tokenizer.html">PasDoc_Tokenizer</a></td>
252247
<td class="itemdesc"><p>Symbols as strings.</p></td>
253248
</tr>
254-
<tr class="list">
249+
<tr class="list2">
255250
<td class="itemname"><a class="bold" href="PasDoc_Tokenizer.html#TokenCommentTypes">TokenCommentTypes</a></td>
256251
<td class="itemunit"><a class="bold" href="PasDoc_Tokenizer.html">PasDoc_Tokenizer</a></td>
257252
<td class="itemdesc"><p>&nbsp;</p></td>
258253
</tr>
259-
<tr class="list2">
254+
<tr class="list">
260255
<td class="itemname"><a class="bold" href="PasDoc_Tokenizer.html#TOKEN_TYPE_NAMES">TOKEN_TYPE_NAMES</a></td>
261256
<td class="itemunit"><a class="bold" href="PasDoc_Tokenizer.html">PasDoc_Tokenizer</a></td>
262257
<td class="itemdesc"><p>Names of the token types.</p></td>
263258
</tr>
264-
<tr class="list">
259+
<tr class="list2">
265260
<td class="itemname"><a class="bold" href="PasDoc_Items.html#VisibilityStr">VisibilityStr</a></td>
266261
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
267262
<td class="itemdesc"><p>&nbsp;</p></td>
268263
</tr>
269-
<tr class="list2">
264+
<tr class="list">
270265
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#WhiteSpace">WhiteSpace</a></td>
271266
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
272267
<td class="itemdesc"><p>Any whitespace (that may indicate newline or not)</p></td>
273268
</tr>
274-
<tr class="list">
269+
<tr class="list2">
275270
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#WhiteSpaceNL">WhiteSpaceNL</a></td>
276271
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
277272
<td class="itemdesc"><p>Whitespace that is some part of newline.</p></td>
278273
</tr>
279-
<tr class="list2">
274+
<tr class="list">
280275
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#WhiteSpaceNotNL">WhiteSpaceNotNL</a></td>
281276
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
282277
<td class="itemdesc"><p>Whitespace that is not any part of newline.</p></td>
283278
</tr>
284279
</table>
285-
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.17.0.snapshot</a>. </em>
280+
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 1.0.0</a>. </em>
286281
</span>
287282
</div></main>
288283
<script src="bootstrap.bundle.min.js"></script>

docs/autodoc/html/AllFunctions.html

Lines changed: 18 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<title>PasDoc's autodoc: All Functions and Procedures</title>
55
<meta name="viewport" content="width=device-width, initial-scale=1">
6-
<meta name="generator" content="PasDoc 0.17.0.snapshot">
6+
<meta name="generator" content="PasDoc 1.0.0">
77
<meta http-equiv="content-type" content="text/html; charset=utf-8">
88
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
99

@@ -107,45 +107,45 @@ <h1 class="allitems">All Functions and Procedures</h1>
107107
<td class="itemdesc"><p>Nice compiler name.</p></td>
108108
</tr>
109109
<tr class="list2">
110+
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#ConvertHelpInsightDescription-string-">ConvertHelpInsightDescription</a></td>
111+
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
112+
<td class="itemdesc"><p>Convert HelpInsight description to PasDoc description, by converting HelpInsight tags like &lt;summary&gt;...&lt;/summary&gt; to PasDoc @tags like @abstract.</p></td>
113+
</tr>
114+
<tr class="list">
110115
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#CopyFile-string-string-">CopyFile</a></td>
111116
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
112117
<td class="itemdesc"><p>&nbsp;</p></td>
113118
</tr>
114-
<tr class="list">
119+
<tr class="list2">
115120
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#DataToFile-string-arrayofByte-">DataToFile</a></td>
116121
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
117122
<td class="itemdesc"><p>Save the binary Data into a file.</p></td>
118123
</tr>
119-
<tr class="list2">
124+
<tr class="list">
120125
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#DeleteFileExt-string-">DeleteFileExt</a></td>
121126
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
122127
<td class="itemdesc"><p>Remove from the FileName the last extension (including the dot).</p></td>
123128
</tr>
124-
<tr class="list">
129+
<tr class="list2">
125130
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#ExtractFirstWord-string-">ExtractFirstWord</a></td>
126131
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
127132
<td class="itemdesc"><p>Extracts all characters up to the first white-space encountered (ignoring white-space at the very beginning of the string) from the string specified by S.</p></td>
128133
</tr>
129-
<tr class="list2">
134+
<tr class="list">
130135
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#ExtractFirstWord-string-string-string-">ExtractFirstWord</a></td>
131136
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
132137
<td class="itemdesc"><p>Another version of ExtractFirstWord.</p></td>
133138
</tr>
134-
<tr class="list">
139+
<tr class="list2">
135140
<td class="itemname"><a class="bold" href="PasDoc_Utils.html#FileToString-string-">FileToString</a></td>
136141
<td class="itemunit"><a class="bold" href="PasDoc_Utils.html">PasDoc_Utils</a></td>
137142
<td class="itemdesc"><p>Read the given FileName contents into a String.</p></td>
138143
</tr>
139-
<tr class="list2">
144+
<tr class="list">
140145
<td class="itemname"><a class="bold" href="PasDoc_Types.html#GlueNameParts-TNameParts-">GlueNameParts</a></td>
141146
<td class="itemunit"><a class="bold" href="PasDoc_Types.html">PasDoc_Types</a></td>
142147
<td class="itemdesc"><p>Simply concatenates all NameParts with dot.</p></td>
143148
</tr>
144-
<tr class="list">
145-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#IDfromLanguage-string-">IDfromLanguage</a></td>
146-
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
147-
<td class="itemdesc"><p>Search for language by short or long name</p></td>
148-
</tr>
149149
<tr class="list2">
150150
<td class="itemname"><a class="bold" href="PasDoc_StringVector.html#IsEmpty-TStringVector-">IsEmpty</a></td>
151151
<td class="itemunit"><a class="bold" href="PasDoc_StringVector.html">PasDoc_StringVector</a></td>
@@ -202,24 +202,14 @@ <h1 class="allitems">All Functions and Procedures</h1>
202202
<td class="itemdesc"><p>Language code, using an official standardardized language names, suitable for Aspell or HTML.</p></td>
203203
</tr>
204204
<tr class="list">
205-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#LanguageDescriptor-TLanguageID-">LanguageDescriptor</a></td>
206-
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
207-
<td class="itemdesc"><p>access LANGUAGE_ARRAY</p></td>
208-
</tr>
209-
<tr class="list2">
210-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#LanguageFromID-TLanguageID-">LanguageFromID</a></td>
211-
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
212-
<td class="itemdesc"><p>&nbsp;</p></td>
213-
</tr>
214-
<tr class="list">
215-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#LanguageFromIndex-integer-">LanguageFromIndex</a></td>
205+
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#LanguageFromStr-string-TLanguageID-">LanguageFromStr</a></td>
216206
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
217-
<td class="itemdesc"><p>Full language name</p></td>
207+
<td class="itemdesc"><p>Find a language with Syntax = S (case ignored).</p></td>
218208
</tr>
219209
<tr class="list2">
220-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#LanguageFromStr-string-TLanguageID-">LanguageFromStr</a></td>
210+
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#LanguageInformation-TLanguageID-">LanguageInformation</a></td>
221211
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
222-
<td class="itemdesc"><p>Find a language with Syntax = S (case ignored).</p></td>
212+
<td class="itemdesc"><p>Read-only language information.</p></td>
223213
</tr>
224214
<tr class="list">
225215
<td class="itemname"><a class="bold" href="PasDoc_Main.html#Main">Main</a></td>
@@ -412,16 +402,6 @@ <h1 class="allitems">All Functions and Procedures</h1>
412402
<td class="itemdesc"><p>Position of the ASub in AString.</p></td>
413403
</tr>
414404
<tr class="list">
415-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#SyntaxFromID-TLanguageID-">SyntaxFromID</a></td>
416-
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
417-
<td class="itemdesc"><p>&nbsp;</p></td>
418-
</tr>
419-
<tr class="list2">
420-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#SyntaxFromIndex-integer-">SyntaxFromIndex</a></td>
421-
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
422-
<td class="itemdesc"><p>Language abbreviation</p></td>
423-
</tr>
424-
<tr class="list">
425405
<td class="itemname"><a class="bold" href="PasDoc_Tipue.html#TipueAddFiles-TPasUnits-TExternalItem-TExternalItem-TExternalItemList-string-string-string-string-string-">TipueAddFiles</a></td>
426406
<td class="itemunit"><a class="bold" href="PasDoc_Tipue.html">PasDoc_Tipue</a></td>
427407
<td class="itemdesc"><p>Adds some additional files to html documentation, needed for tipue engine.</p></td>
@@ -437,22 +417,17 @@ <h1 class="allitems">All Functions and Procedures</h1>
437417
<td class="itemdesc"><p>Put this in &lt;head&gt; of every page with search button.</p></td>
438418
</tr>
439419
<tr class="list2">
440-
<td class="itemname"><a class="bold" href="PasDoc_Languages.html#Translation-TTranslationID-TLanguageID-">Translation</a></td>
441-
<td class="itemunit"><a class="bold" href="PasDoc_Languages.html">PasDoc_Languages</a></td>
442-
<td class="itemdesc"><p>Manual translation of id into lang</p></td>
443-
</tr>
444-
<tr class="list">
445420
<td class="itemname"><a class="bold" href="PasDoc_Items.html#VisibilitiesToStr-TVisibilities-">VisibilitiesToStr</a></td>
446421
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
447422
<td class="itemdesc"><p>Returns VisibilityStr for each value in Visibilities, delimited by commas.</p></td>
448423
</tr>
449-
<tr class="list2">
424+
<tr class="list">
450425
<td class="itemname"><a class="bold" href="PasDoc_Items.html#VisToStr-TVisibility-">VisToStr</a></td>
451426
<td class="itemunit"><a class="bold" href="PasDoc_Items.html">PasDoc_Items</a></td>
452427
<td class="itemdesc"><p>&nbsp;</p></td>
453428
</tr>
454429
</table>
455-
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.17.0.snapshot</a>. </em>
430+
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 1.0.0</a>. </em>
456431
</span>
457432
</div></main>
458433
<script src="bootstrap.bundle.min.js"></script>

0 commit comments

Comments
 (0)