File: AllClasses.html

package info (click to toggle)
pasdoc 0.16.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 33,536 kB
  • sloc: pascal: 28,894; javascript: 7,665; xml: 2,597; makefile: 519; sh: 417
file content (148 lines) | stat: -rw-r--r-- 8,969 bytes parent folder | download
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
<!DOCTYPE html>
<html lang="en">
<head>
<title>All Classes, Interfaces, Objects and Records</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 Classes, Interfaces, Objects and Records</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_expanding_descriptions.EBar.html">EBar</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.EFoo.html">EFoo</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_tag_params_no_parens.EFoo.html">EFoo</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>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.EXyz.html">EXyz</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="warning_abstract_termination.TAbstractTerminationClass.html">TAbstractTerminationClass</a></td>
<td class="itemunit"><a class="bold" href="warning_abstract_termination.html">warning_abstract_termination</a></td>
<td class="itemdesc"><p>(This abstract tag lacks the closing parenthesis. How will PasDoc handle this error?</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_link_class_unit_level.TBar.html">TBar</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>These are links from class' description to an identifiers inside the same class. Note that @links here first check *inside* the class, then outside (i.e. in the whole unit). That's why link to Foo below is a link to a method Foo inside this class, not to a global procedure Foo. Links inside the class: <a class="normal" href="ok_link_class_unit_level.TBar.html#Foo">Foo</a>, <a class="normal" href="ok_link_class_unit_level.TBar.html#Sthg">Sthg</a>.

<p>Links outside of the class: <a class="normal" href="ok_link_class_unit_level.html#Foo">ok_link_class_unit_level.Foo</a>, <a class="normal" href="ok_link_class_unit_level.html#Xyz">Xyz</a>. Note that I has to qualify Foo with unit's name and write &quot;ok_link_class_unit_level.Foo&quot; to get a link to procedure in the unit. Just like I would do in a Pascal code.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_nodescription_printing.TClass1.html">TClass1</a></td>
<td class="itemunit"><a class="bold" href="ok_nodescription_printing.html">ok_nodescription_printing</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_complicated_record.TDoubleEndianCnvRec.html">TDoubleEndianCnvRec</a></td>
<td class="itemunit"><a class="bold" href="ok_complicated_record.html">ok_complicated_record</a></td>
<td class="itemdesc"><p><code>TDoubleEndianCnvRec</code> is used in <a class="normal" href="ok_complicated_record.html#ConvertDouble">ConvertDouble</a> to convert a double to or from the BigEndian format.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_deprecated_tag.TMyClass.html">TMyClass</a></td>
<td class="itemunit"><a class="bold" href="ok_deprecated_tag.html">ok_deprecated_tag</a></td>
<td class="itemdesc"><p> Deprecated class.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_directive_as_identifier.TMyClass.html">TMyClass</a></td>
<td class="itemunit"><a class="bold" href="ok_directive_as_identifier.html">ok_directive_as_identifier</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.TMyClass.html">TMyClass</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>These are some tags that are not allowed to have parameters: name <code>TMyClass</code>, inherited <a class="normal" href="ok_expanding_descriptions.TMyClassAncestor.html">TMyClassAncestor</a>, nil <code>Nil</code>, true <code>True</code>, false <code>False</code>, classname <code>TMyClass</code>. Some of them are valid only within a class, but this is not important for this test.

<p></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_value_member_tags.TMyClass.html">TMyClass</a></td>
<td class="itemunit"><a class="bold" href="ok_value_member_tags.html">ok_value_member_tags</a></td>
<td class="itemdesc"><p>  </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="warning_value_member_tags.TMyClass.html">TMyClass</a></td>
<td class="itemunit"><a class="bold" href="warning_value_member_tags.html">warning_value_member_tags</a></td>
<td class="itemdesc"><p>

<p> 

<p>

<p>This should cause 3 warnings: MyField1 has two descriptions, MyField2 has two descriptions, and NotExistsingMember does not exist.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_expanding_descriptions.TMyClassAncestor.html">TMyClassAncestor</a></td>
<td class="itemunit"><a class="bold" href="ok_expanding_descriptions.html">ok_expanding_descriptions</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_nodescription_printing.TMyRecord.html">TMyRecord</a></td>
<td class="itemunit"><a class="bold" href="ok_nodescription_printing.html">ok_nodescription_printing</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_value_member_tags.TMyRecord.html">TMyRecord</a></td>
<td class="itemunit"><a class="bold" href="ok_value_member_tags.html">ok_value_member_tags</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_nodescription_printing.TMyRecord2.html">TMyRecord2</a></td>
<td class="itemunit"><a class="bold" href="ok_nodescription_printing.html">ok_nodescription_printing</a></td>
<td class="itemdesc"><p>This record has a description, but still LaTeX output will not list it in it's summary list (in the &quot;Overview&quot; section). (i.e. before applying my patch)</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_nodescription_printing.TMyRecord3.html">TMyRecord3</a></td>
<td class="itemunit"><a class="bold" href="ok_nodescription_printing.html">ok_nodescription_printing</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_links.TSomeClass.html">TSomeClass</a></td>
<td class="itemunit"><a class="bold" href="ok_links.html">ok_links</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_links_2.TSomeClass.html">TSomeClass</a></td>
<td class="itemunit"><a class="bold" href="ok_links_2.html">ok_links_2</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_links_2.TSomeOtherClass.html">TSomeOtherClass</a></td>
<td class="itemunit"><a class="bold" href="ok_links_2.html">ok_links_2</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_hint_directives.TTestClassDeprecated.html">TTestClassDeprecated</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_link_explicite_name.TTestingClass.html">TTestingClass</a></td>
<td class="itemunit"><a class="bold" href="ok_link_explicite_name.html">ok_link_explicite_name</a></td>
<td class="itemdesc"><p>I'm a testing class, oh ! And <a class="normal" href="ok_link_explicite_name.TTestingClass.html#MyMethod">don't forget to look at my method !</a></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_hint_directives.TTestRecordDeprecated.html">TTestRecordDeprecated</a></td>
<td class="itemunit"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
</table>
</body></html>