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.

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

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:

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

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.

• 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.

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

• Where To Place Comments

• Writing Documentation

• Supported Tags

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.

See also the list of AdvancedFeatures of PasDoc.

Download:

• Latest stable PasDoc release can be downloaded from here.

• Latest unstable (automatic build after every commit, published once automatic tests pass) release is available here ("snapshot" releases).

You can watch our releases page or announcements category in our discussions to be notified about a new release.

We use GitHub Team Discussions as our forum. Come and talk to us!

Use the GitHub issues to report bugs and feature requests. If you would like to contribute, it’s best to submit a pull request using GitHub.

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.

While developing PasDoc we also developed some other tools, like Pascal preprocessor that you may find useful.

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).