PasDoc

PasDoc is a freely distributed and open source command-line software implemented in Delphi/Object Pascal and designed from the offset to act as a handy and easy-to-use tool that allows Pascal developers to generate documentation for Pascal unit files.

Supports FreePascal, Object Pascal and Delphi specific features

The program fetches the descriptions from comments found inside the source code and generates the documentation in the various file formats. It supports FreePascal, Object Pascal and Delphi specific features, and recognizes code written in Object Pascal or Pascal.

It supports a wide range of output formats, including XML, HTML, LaTeX (PostScript and PDF), HTMLHelp, as well as latex2rft, supports automatic linking of identifiers, supports comment markers, and supports special @-tags for formatting documents, called pasdoc syntax.

Among other interesting features, we can mention support for the modern Object Pascal language that is heavily used in the latest versions of the Delphi and FreePascal programs, as well as support for generating documentation using only the comments written in the source code.

Includes many other advanced features

The software also includes a nice set of advanced features, among which we can mention support for avoiding writing of @link and @abstract tags everywhere, support for adding a search box to the generated documentation, as well as GraphViz support, so you can easily integrate unit dependency graphs and classes.

Its graphical user interface is more easy to use then the command-line interface, if you’re a lazy developer or if you want to get the job do without getting your hands too dirty. Just open the application by running the ‘pasdoc_gui’ command in a terminal emulator or from the Run dialog.

Set the options as you see fit, add the source files by accessing the "Source Files" tab, save your options as a .pds file, and generate the documentation by clicking the "Generate" button or by pressing the F9 key.

What is new in this release:

• Many fixes to parsing "deprecated", "platform", "library" directives.
• simplexml output fixes (by Denis Grinyuk)
• The document creation time is not printed in the docs by default. Use "--include-creation-time" to show it. --include-creation-time is orthogonal to --exclude-generator.
• The build duration time is not printed in the output by default. Use "--verbosity 3" to show it.
• Brazilian utf8 translation (by Alexsander da Rosa)
• Upgrade tipue to 3.0.1, update jquery to 2.0.0.
• Fix Delphi compilation (long generated tipue code) (thanks to Marcos Rocha for investigating)
• Add pasdoc_gui icon (by Karl-Michael Schindler)
• Copyrights and docs fixes (thanks to Paul Gevers)
• Various other small fixes and code cleanups.

What is new in version 0.13.0:

• Handling of declarations nested inside classes (of other types, classes, constans and such) (by Arno Garrels)
• Handling HelpInsight comments (by VCejka)
• Parsing Delphi attributes (by VCejka)
• Parsing "final" standard directive (by VCejka)
• Tipue search upgraded to latest Tipue version, fixes problems in Google Chrome in some cases (by Michalis Kamburelis)
• Parsing of "deprecated", "platform", "library" directives for properties (by Michalis)
• HTML ouput changes (no more , so external links/bookmarks work naturally; tipue search input+button layout corrected) (by Michalis)
• Mac OS X version includes the GUI.
• Many other small fixes and improvements.