PasDoc

1. Introduction

PasDoc is a documentation tool for the Object Pascal code (as implemented by FPC and Delphi). Documentation is generated from comments found in the source code or in special "description files". Numerous output formats are supported, including HTML, LaTeX (for PDF, PS), XML and PHP.

This is a free and open source software.

2. Basic Usage

Put comments before the identifiers in your Pascal source code. Like this:

{ My amazing unit. This does @bold(something amazing). }
unit MyUnit;

interface

type
  { My amazing class. }
  TMyClass = class
  private
    FMyProperty: String;
  public
    { My amazing method. Sets @link(MyProperty) to 'foo'. }
    procedure MyMethod;
    { My amazing property. }
    property MyProperty: String read FMyProperty write FMyProperty;
  end;

implementation
// ...
end.

Process this source code with PasDoc, and get documentation in one of the output formats. From the command-line, you can do it like this:

mkdir -p output-dir/
pasdoc myunit.pas --format=html --output=output-dir

You can also use the GUI interface, see PasDoc GUI.

3. Support Us

If you find PasDoc useful, we appreciate your donations. This helps us to continue improving PasDoc. Michalis, maintainer of PasDoc, also makes Castle Game Engine, and you can use the same channels (like Patreon) to donate to both projects.

4. Examples

Take a look at PasDoc’s own documentation (in the HTML format).
See PasDoc’s own documentation in all the formats.
See Projects using PasDoc for links to larger real-world examples of how documentation generated by PasDoc looks like.

5. Features

For more information on how to document your source code see:

Available output formats:

HTML - modern webpage documenting your project
HtmlHelp
LaTeX - you can use this to generate PDF or PostScript using LaTeX tools like pdflatex
Latex2rtf
SimpleXml - useful to process obtained information using your own tools, you only need to read the generated XML file
PHP - PHP map from Pascal identifier → HTML link, to implement searching/enumeration in PHP websites

Check out the CommandLine to get a better feeling for how PasDoc works.

7. Get involved

8. Development

See the ChangeLog for recent changes to PasDoc.

PasDoc source code:

PasDoc is licensed under the GNU General Public License.
You can get the latest PasDoc sources from our project on GitHub. In short, just call
```
git clone https://github.com/pasdoc/pasdoc.git
```
See compiling PasDoc for instructions how to compile PasDoc.
See release making to know how we test and package PasDoc for final releases.

About these web pages:

We are using wiki to easily update these pages. You are welcome to contribute to the documentation!
All text within this wiki is licensed on terms of GNU General Public License (just like PasDoc sources).