PasDoc is a documentation tool for the Object Pascal code (as implemented by FreePascal and Delphi). Documentation is generated from comments found in the source code and from external files.

Download

Download:

You can watch our releases page to be notified about the new releases.

Usage

See WhereToPlaceComments, WritingDocumentation and SupportedTags for information on how to document your source code.

Available output formats are

  • HTML - modern webpage documenting your project

  • HtmlHelp

  • LaTeX - you can use this to generate PDF or PS using LaTeX tools like pdflatex

  • Latex2rtf

  • SimpleXml - useful to process obtained information using further tools

  • 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. There is also a GUI interface, see PasDocGui.

Check out PasDocAutoDoc and ProjectsUsingPasDoc to see some real-world examples of how documentation generated by PasDoc looks like, and to see some programs that use PasDoc’s code.

You may also be interested in the list of AdvancedFeatures of PasDoc.

Get involved

We use GitHub Team Discussions as our forum. You’re welcome to join there, everyone is welcome :)

You can also 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, although you can also attach a patch file to an issue.

We have also collected some older "wanted features" on the WantedFeatures list. And there is a ToDo list.

Development

See the ChangeLog for recent changes to PasDoc and a short history overview.

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

    Alternatively, you can get the same code using SVN. In short, just call

    svn co https://github.com/pasdoc/pasdoc.git/trunk

  • See CompilingPasDoc for instructions how to compile PasDoc.

  • See ReleaseMaking to know how we test and package PasDoc for final releases.

While developing PasDoc we also developed some OtherTools 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).