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
|
<!DOCTYPE html>
<html lang="en">
<head>
<title>My introduction</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>
<div class="container"><div class="navigation">
<h2><a href="ok_introduction.html">My introduction</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><a href="ok_additionalfile1.html">First additional file</a></li><li><a href="ok_additionalfile2.html">Second additional file</a></li><li><a href="ok_conclusion.html">Conclusion</a></li></ul></div><div class="content">
<h1 class="externalitem">Long descriptive name of my introduction</h1>
<p>
<p><h2 class=""><span id="SecFirst"></span>First section</h2>
<p>This file is supposed to contain some introductory material about whole code included in your documentation. You can note that all rules that apply to normal pasdoc descriptions apply also here, e.g. empty line means new paragraph:
<p>New paragraph.
<p>3rd paragraph. URLs are automatically recognized, like this: <a href="http://pasdoc.sourceforge.net/">http://pasdoc.sourceforge.net/</a>. You have to write the @ twice (like @@) to get one @ in the output. Also normal @-tags work: <code>This is some code.</code>
<p><h2 class=""><span id="SecSecond"></span>Second section</h2>
<p>Here you can see some hot snippet from implementation of this feature, just to test @longcode tag:
<p></p>
<pre class="longcode">
<span class="pascal_keyword">procedure</span> TPasDoc.HandleExtraFile(<span class="pascal_keyword">const</span> FileName: <span class="pascal_keyword">string</span>;
<span class="pascal_keyword">out</span> ExtraDescription: TExtraDescription);
<span class="pascal_keyword">begin</span>
ExtraDescription := TExtraDescription.Create;
<span class="pascal_keyword">try</span>
DoMessage(<span class="pascal_numeric">2</span>, mtInformation, <span class="pascal_string">'Now parsing file %s...'</span>, [FileName]);
ExtraDescription.<span class="pascal_keyword">Name</span> := SCharsReplace(
ChangeFileExt( ExtractFileName(FileName) , <span class="pascal_string">''</span>), [<span class="pascal_string">' '</span>], <span class="pascal_string">'_'</span>);
ExtraDescription.RawDescription := FileToString(FileName);
<span class="pascal_keyword">except</span>
FreeAndNil(ExtraDescription);
<span class="pascal_keyword">raise</span>;
<span class="pascal_keyword">end</span>;
<span class="pascal_keyword">end</span>;</pre>
<p>
<p><h2 class=""><span id="ThirdSecond"></span>Third section</h2>
<p>Normal links work : <a class="normal" href="ok_introduction_conclusion.html#MyConstant">MyConstant</a>.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p><span id="SomeAnchor"></span> Here is a paragraph with an anchor. It looks like a normal paragraph, but you can link to it with @link(SomeAnchor).
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Blah.
<p>Sections with the same user-visible names are OK (example when this is useful is below):
<p><h2 class=""><span id="SecStrings"></span>Routines dealing with strings</h2>
<p><h3 class=""><span id="SecStringsOverview"></span>Overview</h3>
<p><h3 class=""><span id="SecStringsExamples"></span>Examples</h3>
<p><h2 class=""><span id="SecIntegers"></span>Routines dealing with integers</h2>
<p><h3 class=""><span id="SecIntegersOverview"></span>Overview</h3>
<p><h3 class=""><span id="SecIntegersExamples"></span>Examples</h3>
<h2 class="authors">Author</h2>
<ul class="authors">
<li>Kambi</li>
</ul>
<h2 class="created">Created</h2>
<p>
On some rainy day
</p>
</div></div></body></html>
|
