Difference between revisions of "PasDoc"

From Free Pascal wiki
(Download: GitHub link first)
(Better list of features in the "About" section)
Line 1: Line 1:
 
=About=
 
=About=
PasDoc is a documentation tool for Object Pascal code, able to parse all modern Pascal features. Documentation is generated from comments found in your source code and from external files.  
+
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.
  
Output formats are HTML, HtmlHelp, LaTeX, latex2rtf, simplexml. More formats may be added in the future.
+
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=
 
=Download=
Line 14: Line 25:
  
 
   svn co http://svn.code.sf.net/p/pasdoc/code/trunk
 
   svn co http://svn.code.sf.net/p/pasdoc/code/trunk
Github:
 
 
  https://github.com/michaliskambi/pasdoc
 
  
 
=License=
 
=License=

Revision as of 17:04, 25 September 2016

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: http://pasdoc.sourceforge.net/

Github:

 git clone https://github.com/michaliskambi/pasdoc

SourceForge SVN (auto-synchronized with GitHub):

 svn co http://svn.code.sf.net/p/pasdoc/code/trunk

License

GNU GPL.