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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
<!DOCTYPE html>
<html lang="en">
<head>
<title>All Functions and Procedures</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<h1 class="allitems">All Functions and Procedures</h1>
<table class="itemstable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemunit">Unit</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_cdecl_external.html#Bar">Bar</a></td>
<td class="itemunit"><a class="bold" href="ok_cdecl_external.html">ok_cdecl_external</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_directive_as_identifier.html#Bar">Bar</a></td>
<td class="itemunit"><a class="bold" href="ok_directive_as_identifier.html">ok_directive_as_identifier</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_directive_as_identifier.html#Cdecl">Cdecl</a></td>
<td class="itemunit"><a class="bold" href="ok_directive_as_identifier.html">ok_directive_as_identifier</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_complicated_record.html#ConvertDouble">ConvertDouble</a></td>
<td class="itemunit"><a class="bold" href="ok_complicated_record.html">ok_complicated_record</a></td>
<td class="itemdesc"><p><code>ConvertDouble</code> converts Value to or from the BigEndian format.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_cdecl_external.html#Foo">Foo</a></td>
<td class="itemunit"><a class="bold" href="ok_cdecl_external.html">ok_cdecl_external</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_directive_as_identifier.html#Foo">Foo</a></td>
<td class="itemunit"><a class="bold" href="ok_directive_as_identifier.html">ok_directive_as_identifier</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_link_class_unit_level.html#Foo">Foo</a></td>
<td class="itemunit"><a class="bold" href="ok_link_class_unit_level.html">ok_link_class_unit_level</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_paragraph_in_single_line_comment.html#Foo">Foo</a></td>
<td class="itemunit"><a class="bold" href="ok_paragraph_in_single_line_comment.html">ok_paragraph_in_single_line_comment</a></td>
<td class="itemdesc"><p>This is the 1st paragraph.
<p>This is the 2nd paragraph.
<p>This is the 3rd paragraph.
<p>Here paragraphs are correct.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="warning_tags_no_parameters.html#Foo">Foo</a></td>
<td class="itemunit"><a class="bold" href="warning_tags_no_parameters.html">warning_tags_no_parameters</a></td>
<td class="itemdesc"><p>Some tags are not allowed to have parameters.
<p>pasdoc should print a warning when you try to give some parameters for such tags: e.g. <code>Nil</code>, <code>True</code>.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_directive_as_identifier.html#Foo1">Foo1</a></td>
<td class="itemunit"><a class="bold" href="ok_directive_as_identifier.html">ok_directive_as_identifier</a></td>
<td class="itemdesc"><p>Some other test for THTMLDocGenerator.WriteCodeWithLinks, while I'm at it:
<p>Note that link to TMyClass should be correctly made. 'register' should be displayed as a string, of course, and not linked.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_links_2.html#MyOtherProc">MyOtherProc</a></td>
<td class="itemunit"><a class="bold" href="ok_links_2.html">ok_links_2</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_deprecated_tag.html#MyProc">MyProc</a></td>
<td class="itemunit"><a class="bold" href="ok_deprecated_tag.html">ok_deprecated_tag</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_links.html#MyProc">MyProc</a></td>
<td class="itemunit"><a class="bold" href="ok_links.html">ok_links</a></td>
<td class="itemdesc"><p>Link to self : <a class="normal" href="ok_links.html#MyProc">MyProc</a>, and a second one: <a class="normal" href="ok_links.html#MyProc">ok_links.MyProc</a>, link to MyProc in other unit: <a class="normal" href="ok_links_2.html#MyProc">ok_links_2.MyProc</a>.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_links_2.html#MyProc">MyProc</a></td>
<td class="itemunit"><a class="bold" href="ok_links_2.html">ok_links_2</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_link_explicite_name.html#MyProc">MyProc</a></td>
<td class="itemunit"><a class="bold" href="ok_link_explicite_name.html">ok_link_explicite_name</a></td>
<td class="itemdesc"><p>Some testing proc. <a class="normal" href="ok_link_explicite_name.TTestingClass.html#MyMethod">Have you seen my method ?</a></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_nodescription_printing.html#MyProc">MyProc</a></td>
<td class="itemunit"><a class="bold" href="ok_nodescription_printing.html">ok_nodescription_printing</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.html#RecursiveTwoAt">RecursiveTwoAt</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>aa aaaaa aa aaa <code>SHGetSpecialFolderPath(0, @Path, CSIDL_APPDATA, true)</code> aaaa aaaaaa aaaaaa aaaaaaaaa aaaa
<p>At some point, this test caused the bug: final </code> tag was inserted in converted form (processed with ConvertString) into html output. In effect, there was an opening <code> tag but there was no closing </code> tag.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_directive_as_identifier.html#Register">Register</a></td>
<td class="itemunit"><a class="bold" href="ok_directive_as_identifier.html">ok_directive_as_identifier</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_tag_params_no_parens.html#SomeProc">SomeProc</a></td>
<td class="itemunit"><a class="bold" href="ok_tag_params_no_parens.html">ok_tag_params_no_parens</a></td>
<td class="itemdesc"><p>Note that this rule allows you to not specify () for *any* tag that has parameters. Even for @link tag: <a class="normal" href="ok_tag_params_no_parens.html">ok_tag_params_no_parens</a>
<p>This rule doesn't create any problems for tags without parameters, like the @name tag: here it is: <code>SomeProc</code>. Such tags never have parameters, and on the above line you *don't* have @name tag with parameters "tag. Such tags never have parameters,". Instead, you just specified <code>SomeProc</code> tag and "tag. Such tags never have parameters," is just a normal text.
<p>Check out this longcode: </p>
<pre class="longcode"><span class="pascal_keyword">begin</span> Writeln(<span class="pascal_string">'Hello world'</span>); <span class="pascal_keyword">end</span>; <span class="pascal_comment">{ This works ! }</span></pre>
<p>
<p>See also @html and @latex tags: <font style="color: #ff0000">I'm red</font>
<p>And here is some code: <code>begin X := Y + 1; end;</code>
<p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_complicated_record.html#SwapDoubleBytes">SwapDoubleBytes</a></td>
<td class="itemunit"><a class="bold" href="ok_complicated_record.html">ok_complicated_record</a></td>
<td class="itemdesc"><p><code>SwapDoubleBytes</code> copies <a class="normal" href="ok_complicated_record.TDoubleEndianCnvRec.html#Bytes">TDoubleEndianCnvRec.Bytes</a> in reverse order from Sourceˆ to Destˆ.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_hint_directives.html#TestFuncCombined">TestFuncCombined</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_hint_directives.html#TestFuncDeprecated">TestFuncDeprecated</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_hint_directives.html#TestFuncPlatform">TestFuncPlatform</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.html#TestHtmlAndLatexTags">TestHtmlAndLatexTags</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>
This is some <b>dummy</b> html code, just to show that inside
@html tag of pasdoc (note that I used single @ char in this sentence)
nothing is expanded by pasdoc.
No paragraphs are created by pasdoc. (This text is still in the 1st,
not in the 2nd, paragraph in html output)
<p>You must explicitly write <p> to get paragraph.
No tags work, e.g. @link(TestLongCode).
<p>
<p>Note that text inside @html / @latex tags is absolutely not touched by pasdoc. Characters are not escaped (< is *not* changed to &lt; in the html case), @tags are not expanded, @ needs not to be doubled, paragraphs (<p> in the html case) are not inserted.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_line_break.html#TestLineBreak">TestLineBreak</a></td>
<td class="itemunit"><a class="bold" href="ok_line_break.html">ok_line_break</a></td>
<td class="itemdesc"><p>1st paragraph. <br> Second line of 1st paragraph.
<p>2nd paragraph. Blah blah blah.
<p>3rd paragraph. <br> Second line of 3rd paragraph.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.html#TestLongCode">TestLongCode</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>Note that inside @longcode below I should be able to write singe @ char to get it in the output, no need to double it (like @@). No tags are expanded inside longcode.
<p>Also note that paragraphs are not expanded inside longcode (no <p> inside <pre>...</pre> in html output).
<p>Of course html characters are still correctly escaped (< changes to &lt; etc.).
<p></p>
<pre class="longcode">
<span class="pascal_keyword">procedure</span> Foo;
<span class="pascal_keyword">begin</span>
<span class="pascal_keyword">if</span> A < B <span class="pascal_keyword">then</span> Bar; <span class="pascal_comment">{ @link(No, this is not really pasdoc tag) }</span>
<span class="pascal_keyword">end</span>;
<span class="pascal_keyword">procedure</span> Bar(X: Integer);
<span class="pascal_keyword">begin</span>
CompareMem(@X, @Y);
<span class="pascal_keyword">end</span>;</pre>
<p></p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.html#TestPasMethodTags">TestPasMethodTags</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>This is a test of tags expanded by TPasMethod handlers. Note that all three tags are expanded recursively.
<p>
<p>
<p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_hint_directives.html#TestProcCombined">TestProcCombined</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_hint_directives.html#TestProcDeprecated">TestProcDeprecated</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_hint_directives.html#TestProcPlatform">TestProcPlatform</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.html#TestRecursiveTag">TestRecursiveTag</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>@code and @returns (and some others) tags are recursive, you can freely put other tags inside.
<p><code>This is link to <a class="normal" href="ok_expanding_descriptions.html#TestHtmlAndLatexTags">TestHtmlAndLatexTags</a>.</code>
<p></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="warning_not_existing_tags.html#TestWarnings">TestWarnings</a></td>
<td class="itemunit"><a class="bold" href="warning_not_existing_tags.html">warning_not_existing_tags</a></td>
<td class="itemdesc"><p>pasdoc should complain (display warnings) about wrong tags : @firstwarning(blah blah), <code>Wrong tag inside a @code: @secondwarning(ble ble)</code>.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.html#TwoAt">TwoAt</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>Write two at chars, like this @@, to get one @ in output.
<p>E.g. @ link(TSomeClass).
<p>E.g. @link(TSomeClass).
<p>E.g. @html foobar.
<p>E.g. @link .</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_cdecl_external.html#Xyz">Xyz</a></td>
<td class="itemunit"><a class="bold" href="ok_cdecl_external.html">ok_cdecl_external</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_link_class_unit_level.html#Xyz">Xyz</a></td>
<td class="itemunit"><a class="bold" href="ok_link_class_unit_level.html">ok_link_class_unit_level</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
</table>
</body></html>
|
