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
|
@title(Long descriptive name of the first additional file:)
@shorttitle(First additional file)
@author(Kambi)
@created(On some rainy day)
@section(1 SecFirst First section)
This file is supposed to contain any additional
information that you wish to include 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:
New paragraph.
3rd paragraph. URLs are automatically recognized, like this:
http://pasdoc.sourceforge.net/. You have to write the @@ twice
(like @@@@) to get one @@ in the output. Also normal @@-tags work:
@code(This is some code.)
@section(1 SecSecond Second section)
Here you can see some hot snippet from implementation of this
feature, just to test @@longcode tag:
@longcode(#
procedure TPasDoc.HandleExtraFile(const FileName: string;
out ExtraDescription: TExtraDescription);
begin
ExtraDescription := TExtraDescription.Create;
try
DoMessage(2, mtInformation, 'Now parsing file %s...', [FileName]);
ExtraDescription.Name := SCharsReplace(
ChangeFileExt( ExtractFileName(FileName) , ''), [' '], '_');
ExtraDescription.RawDescription := FileToString(FileName);
except
FreeAndNil(ExtraDescription);
raise;
end;
end;
#)
@section(1 ThirdSecond Third section)
Normal links work : @link(MyConstant).
Blah.
Blah.
Blah.
Blah.
Blah.
Blah.
@anchor(SomeAnchor) Here is a paragraph with an anchor.
It looks like a normal paragraph, but you can link to it
with @@link(SomeAnchor).
Blah.
Blah.
Blah.
Blah.
Blah.
Blah.
Blah.
Blah.
Blah.
Sections with the same user-visible names are OK (example
when this is useful is below):
@section(1 SecStrings Routines dealing with strings)
@section(2 SecStringsOverview Overview)
@section(2 SecStringsExamples Examples)
@section(1 SecIntegers Routines dealing with integers)
@section(2 SecIntegersOverview Overview)
@section(2 SecIntegersExamples Examples)
|
