You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/index.asciidoc
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,26 +13,19 @@ and / or in dedicated "description files". Numerous output formats are supported
13
13
14
14
This is a _free and open source software_.
15
15
//PasDoc itself is written using modern Object Pascal and can be build using FPC or Delphi.
16
-
We https://castle-engine.io/donate[appreciate your donations (Michalis, maintainer of PasDoc, also makes Castle Game Engine)], esp. if you use PasDoc in a commercial project. This helps us to continue developing and improving PasDoc.
17
-
18
-
## Download
19
-
20
-
Download:
21
-
22
-
* Latest *stable* PasDoc release https://github.com/pasdoc/pasdoc/releases/latest[can be downloaded from here].
23
16
24
-
* Latest *unstable* (automatic build after every commit, published once automatic tests pass) release https://github.com/pasdoc/pasdoc/releases/tag/snapshot[is available here ("snapshot" releases)].
25
-
26
-
You can watch our https://github.com/pasdoc/pasdoc/releases[releases page] or https://github.com/pasdoc/pasdoc/discussions/categories/announcements[announcements category in our discussions] to be notified about a new release.
17
+
We https://castle-engine.io/donate[appreciate your donations (Michalis, maintainer of PasDoc, also makes Castle Game Engine)], esp. if you use PasDoc in a commercial project. This helps us to continue developing and improving PasDoc.
27
18
28
-
##Tutorial
19
+
##Basic Usage
29
20
30
21
Put comments before the identifiers in your Pascal source code. Like this:
31
22
32
23
```pascal
33
24
{ My amazing unit. }
34
25
unit MyUnit;
26
+
35
27
interface
28
+
36
29
type
37
30
{ My amazing class. }
38
31
TMyClass = class
@@ -42,6 +35,7 @@ type
42
35
{ My amazing property. }
43
36
property MyProperty: string read GetMyProperty;
44
37
end;
38
+
45
39
implementation
46
40
...
47
41
end.
@@ -58,20 +52,20 @@ You can also use the GUI interface, see link:PasDocGui[PasDoc GUI].
58
52
59
53
## Examples
60
54
61
-
- This is https://pasdoc.github.io/autodoc/html/index.html[PasDoc's own documentation in the HTML format].
55
+
- Take a look at https://pasdoc.github.io/autodoc/html/index.html[PasDoc's own documentation (in the HTML format)].
62
56
63
-
- See also link:PasDocAutoDoc[PasDoc's own documentation in all the formats].
57
+
- See link:PasDocAutoDoc[PasDoc's own documentation in all the formats].
64
58
65
59
- See link:ProjectsUsingPasDoc[Projects using PasDoc] for links to larger real-world
66
60
examples of how documentation generated by PasDoc looks like.
Check out the link:CommandLine[CommandLine] to get a better feeling
86
80
for how PasDoc works.
87
81
88
-
You may also be interested in the list of
89
-
link:AdvancedFeatures[AdvancedFeatures] of PasDoc.
82
+
See also the list of link:AdvancedFeatures[AdvancedFeatures] of PasDoc.
83
+
84
+
## All Downloads (Stable and Unstable)
85
+
86
+
Download:
87
+
88
+
* Latest *stable* PasDoc release https://github.com/pasdoc/pasdoc/releases/latest[can be downloaded from here].
89
+
90
+
* Latest *unstable* (automatic build after every commit, published once automatic tests pass) release https://github.com/pasdoc/pasdoc/releases/tag/snapshot[is available here ("snapshot" releases)].
91
+
92
+
You can watch our https://github.com/pasdoc/pasdoc/releases[releases page] or https://github.com/pasdoc/pasdoc/discussions/categories/announcements[announcements category in our discussions] to be notified about a new release.
0 commit comments