|
1 | 1 | :doctitle: Michalis Kamburelis |
| 2 | +:sectnums: |
| 3 | +:toc: left |
| 4 | +:toclevels: 4 |
2 | 5 |
|
3 | | -I'm one of pasdoc's developers. I use pasdoc most of all to document my |
4 | | -https://castle-engine.io/[Castle Game Engine], an |
5 | | -open-source 3D and 2D game engine for Object Pascal. My webpage is |
6 | | -http://michalis.ii.uni.wroc.pl/~michalis/ |
| 6 | +I'm the main developer of PasDoc right now. |
7 | 7 |
|
8 | | -''''' |
| 8 | +My primary PasDoc usage is to to document my https://castle-engine.io/[Castle Game Engine], an |
| 9 | +open-source 3D and 2D game engine for Object Pascal. The https://castle-engine.io/apidoc/html/[Castle Game Engine API documentation] is generated by PasDoc. |
9 | 10 |
|
10 | | -## [[adding-new-feature-to-pasdoc]] Adding new feature to pasdoc |
| 11 | +My other projects are https://michalis.xyz/[on my personal webpage]. |
11 | 12 |
|
12 | | -When adding new end-user visible feature, remember to always |
| 13 | +## [[adding-new-feature-to-pasdoc]] Cheatsheet: Adding new feature to pasdoc |
13 | 14 |
|
14 | | -* add an entry to ChangeLog.md |
15 | | -* add a testcase to tests/ |
16 | | -* add a documentation to wiki |
| 15 | +When adding new end-user visible feature, remember to always |
17 | 16 |
|
18 | | -''''' |
| 17 | +* add an entry to https://github.com/pasdoc/pasdoc/blob/master/ChangeLog.md[ChangeLog.md] |
| 18 | +* add a testcase to https://github.com/pasdoc/pasdoc/tree/master/tests[tests/] |
| 19 | +* add a documentation to https://github.com/pasdoc/pasdoc.github.io[our website, in AsciiDoc format]. |
| 20 | +* announce in our https://github.com/pasdoc/pasdoc/discussions/categories/announcements[announcements category on GitHub discussions]. |
19 | 21 |
|
20 | | -## [[should-documentation-be-placed-inside-units-interface-or-in-separate-files]] Should documentation be placed inside units interface, or in separate files ? |
| 22 | +## [[should-documentation-be-placed-inside-units-interface-or-in-separate-files]] Thinking out loud: Should documentation be placed inside units interface, or in separate files? |
21 | 23 |
|
22 | 24 | Stating it differently, which way is better: |
23 | 25 |
|
@@ -103,7 +105,7 @@ method, where it can be kept better in sync with the actual |
103 | 105 | implementation. We definitely deserve an merge of descriptions, from |
104 | 106 | different sources/places. |
105 | 107 |
|
106 | | -''''' |
| 108 | +
|
107 | 109 |
|
108 | 110 | ## [[some-todo-things]] Some TODO things |
109 | 111 |
|
@@ -499,6 +501,6 @@ command-line option, --auto-link, and can be locally deactivated by |
499 | 501 | ** http://txt2tags.sourceforge.net/[txt2tags]. A nice standalone text formatter. Better than aft because it doesn't make problems when you don't write in ISO-8859-1 character set (but e.g. in ISO-8859-2 set that includes Polish chars). |
500 | 502 | ** http://www.lrde.epita.fr/people/theo/html/ocaml_ref/manual029.html[ocamldoc]. pasdoc equivalent for ocaml. ocamldoc has some nice bits of wiki-like syntax for some things, e.g. for lists. |
501 | 503 |
|
502 | | -''''' |
| 504 | +
|
503 | 505 |
|
504 | 506 | link:CategoryHomepage[CategoryHomepage] |
0 commit comments