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
|
<!DOCTYPE html>
<html lang="en">
<head>
<title>All Units</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 Units</h1>
<table class="unitstable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_cdecl_external.html">ok_cdecl_external</a></td>
<td class="itemdesc"><p>Bug:
<p>Parsing of this unit fails with Warning[2]: Error EPasDoc: todo/ok_cdecl_external.pas(5): Unexpected keyword external. parsing unit ok_cdecl_external.pas, continuing...
<p>Bar and Xyz added as additional tests.
<p>Update: it's fixed now, pasdoc parses it correctly.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_complicated_record.html">ok_complicated_record</a></td>
<td class="itemdesc"><p> This unit is used for converting to and from the BigEndian format. See <a href="http://community.borland.com/article/0,1410,28964,00.html">http://community.borland.com/article/0,1410,28964,00.html</a>.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_deprecated_tag.html">ok_deprecated_tag</a></td>
<td class="itemdesc"><p>Test @deprecated tag.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_directive_as_identifier.html">ok_directive_as_identifier</a></td>
<td class="itemdesc"><p>All calling-convention specifiers must *not* be made links in docs. But "Register" procedure name must be made a link. Yes, the difficulty is here that "register" is once a calling-convention specifier and once a procedure name.
<p>This is related to bug submitted to pasdoc-main list [<a href="http://sourceforge.net/mailarchive/message.php?msg_id=11397611">http://sourceforge.net/mailarchive/message.php?msg_id=11397611</a>].</p></td>
</tr>
<tr class="list">
<td class="itemname"><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 TPasItem handlers. Of course with @abstract tag using some recursive tag: See also <a class="normal" href="ok_expanding_descriptions.html#TestPasMethodTags">TestPasMethodTags</a></p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_hint_directives.html">ok_hint_directives</a></td>
<td class="itemdesc"><p>Test parsing "platform", "library" and "deprecated" directives (called collectively "hint directives") by pasdoc.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_line_break.html">ok_line_break</a></td>
<td class="itemdesc"><p>Test @br tag.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_links.html">ok_links</a></td>
<td class="itemdesc"><p>Test various things with links.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_links_2.html">ok_links_2</a></td>
<td class="itemdesc"><p>Helper unit for test in ok_links.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_link_class_unit_level.html">ok_link_class_unit_level</a></td>
<td class="itemdesc"><p>This is a link from unit's description to an identifier inside the same unit: some procedure <a class="normal" href="ok_link_class_unit_level.html#Foo">Foo</a>, some class <a class="normal" href="ok_link_class_unit_level.TBar.html">TBar</a>.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_link_explicite_name.html">ok_link_explicite_name</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_nodescription_printing.html">ok_nodescription_printing</a></td>
<td class="itemdesc"><p>pasdoc's LaTeX documentation of this unit omitted many things before revision 1.20 of PasDoc_GenLatex.pas. Html docs were ok.
<p>I explained why omitting docs for things that don't have any documentation comment is bad in the letter "Fix for LaTeX genetator omitting some things" [<a href="http://sourceforge.net/mailarchive/forum.php?thread_id=6948809&forum_id=4647">http://sourceforge.net/mailarchive/forum.php?thread_id=6948809&forum_id=4647</a>]
<p>Now, all identifiers in this unit should be visible in LaTeX documentation (and in html output too, of course).</p></td>
</tr>
<tr class="list">
<td class="itemname"><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>pasdoc should create paragraphs when glueing single-line comments to a description, but it doesn't for now. Update: now it does.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="ok_tag_name_case.html">ok_tag_name_case</a></td>
<td class="itemdesc"><p>Trivial unit to test that tag case does not matter.
<p><code>Foo</code>
<p><code>Foo</code>
<p><code>Foo</code></p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="ok_tag_params_no_parens.html">ok_tag_params_no_parens</a></td>
<td class="itemdesc"><p>This is a demo unit using tags without enclosing them in ()</p></td>
</tr>
<tr class="list2">
<td class="itemname"><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_abstract_termination.html">warning_abstract_termination</a></td>
<td class="itemdesc"><p>The abstract tag for <a class="normal" href="warning_abstract_termination.TAbstractTerminationClass.html">TAbstractTerminationClass</a> is unterminated. PasDoc should either terminate the tag itself, give a warning, or both</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="warning_abstract_twice.html">warning_abstract_twice</a></td>
<td class="itemdesc"><p>Second abstract</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="warning_not_existing_tags.html">warning_not_existing_tags</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="warning_tags_no_parameters.html">warning_tags_no_parameters</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="warning_value_member_tags.html">warning_value_member_tags</a></td>
<td class="itemdesc"><p> </p></td>
</tr>
</table>
</body></html>
|
