Difference between revisions of "PasDoc"
From Free Pascal wiki
Jump to navigationJump to search (Better list of features in the "About" section) |
(demote all level-1 headings to level-2 headings [the page title is 𝘵𝘩𝘦 level-1 heading], insert some wikilinks, update URL) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | =About= | + | ==About== |
| − | PasDoc is a documentation tool for the Object Pascal code. Documentation is generated from comments found in your source code and from external files. It can parse source code with all the modern Pascal features. Inside the documentation you can use many @-tags for formatting and linking. | + | PasDoc is a documentation tool for the [[Object Pascal]] code. Documentation is generated from [[Comments|comments]] found in your [[Source code|source code]] and from external files. It can parse source code with all the modern Pascal features. Inside the documentation you can use many [[@]]-tags for formatting and linking. |
Many output formats are supported: HTML, HtmlHelp, LaTeX, latex2rtf, simplexml. | Many output formats are supported: HTML, HtmlHelp, LaTeX, latex2rtf, simplexml. | ||
| Line 15: | Line 15: | ||
* caching to speedup generating large documentation. | * caching to speedup generating large documentation. | ||
| − | =Download= | + | ==Download== |
| − | Homepage: | + | Homepage: https://pasdoc.github.io/ |
| − | Github: | + | Github: |
| − | git clone https://github.com/ | + | git clone https://github.com/pasdoc/pasdoc |
SourceForge SVN (auto-synchronized with GitHub): | SourceForge SVN (auto-synchronized with GitHub): | ||
| Line 26: | Line 26: | ||
svn co http://svn.code.sf.net/p/pasdoc/code/trunk | svn co http://svn.code.sf.net/p/pasdoc/code/trunk | ||
| − | =License= | + | ==License== |
| − | GNU GPL. | + | GNU [[GPL]]. |
| − | |||
[[Category:Help and Docs]] | [[Category:Help and Docs]] | ||
[[Category:Tools]] | [[Category:Tools]] | ||
Latest revision as of 22:45, 21 January 2022
About
PasDoc is a documentation tool for the Object Pascal code. Documentation is generated from comments found in your source code and from external files. It can parse source code with all the modern Pascal features. Inside the documentation you can use many @-tags for formatting and linking.
Many output formats are supported: HTML, HtmlHelp, LaTeX, latex2rtf, simplexml.
There's a command-line and GUI interface.
Some of the advanced features include:
- support for many languages to localize your documentation,
- configurable comment markers,
- you can create large introduction pages for your documentation using the same markup,
- easy search box for the documentation,
- configurable automatic linking and automatic extraction of "abstracts" from the documentation,
- spell checking,
- caching to speedup generating large documentation.
Download
Homepage: https://pasdoc.github.io/
Github:
git clone https://github.com/pasdoc/pasdoc
SourceForge SVN (auto-synchronized with GitHub):
svn co http://svn.code.sf.net/p/pasdoc/code/trunk
License
GNU GPL.
