View Full Version : Recommendations for generating documentation from Pascal/Delphi source code?

10-10-2011, 12:26 AM
Hi all,
I was wondering what free programs, utilities, etc. that people could recommend so I can generate documentation from Pascal/Delphi source code?

I know of PasDoc, but I was wondering if there are others, and what you guys/gals are using (if anything).

I want to create in-house documentation for the internals of my cross-platform library, and documentation for the interface part for end-users too...

Also, what format do you think would be best for help documentation? .chm (doesn't work on all windows platforms? not cross-platform?), .pdf, .html, some other format?


10-10-2011, 02:11 AM
i recommend using .html cause you can change anything without much effort and can easily converted it to .chm or .pdf

nice thing for documentations are wiki like systems, easy to maintenance and good to read

you can check FPDoc (http://www.freepascal.org/docs-html/fpdoc/fpdoc.html)

10-10-2011, 02:22 AM
Thanks for the tip, I might go the .html route then - any ideas as to what I could use to generate the documentation now then? :D


10-10-2011, 10:50 AM
Hi Paul,

I've checked out a bunch of tools for this and the one that works best for me is PasDoc. It generates HTML and provides a build file (IIRC) for compiling the generated pages into a CHM. It can also do one or two funkier tricks like generating files for (IIRC) GraphVis, to generate a dependancy chart. These can get a bit messy for large projects.

It's comment format is simple enough and it does support a number of useful things like includes.

You can grab it from http://sourceforge.net/projects/pasdoc/

10-10-2011, 11:12 AM
Thanks Christina, I will take another look at PasDoc :)