Home

Michalis Kamburelis edited this page Jan 8, 2017 · 13 revisions
PasDoc, documentation generator for Pascal:
Features:
Supported Tags:
Command Line:
Development:
Developers pages:
Clone this wiki locally

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 stable PasDoc releases at Sourceforge download page.

You can watch our news 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, HtmlHelp, LaTeX, Latex2rtf, SimpleXml. More output formats may be added in the future.

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

Subscribe and post to our "pasdoc-main" mailing list to discuss anything related to PasDoc. All the developers are listening there:)

You can also use the SourceForge ticket system to report bugs and feature requests. Patches can be submittted as attachments to the patches tracker, or you can submit pull requests through GitHub.

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.

If you want to get the newer version of PasDoc but yout don’t want to compile PasDoc yourself, you can try DevelopmentSnapshots.

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 from the SVN. You can use GitHub repository as an SVN URL, or you can use SourceForge SVN (automatically synchronized). In short, just call

    svn co http://svn.code.sf.net/p/pasdoc/code/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).