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
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
Last edited by Daikrys; 10-10-2011 at 02:18 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?
cheers,
Paul
Games:
Seafox
Pages:
Syntax Error Software
itch.io page
Online Chess
http://gameknot.com/#paul_nicholls
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/
:: AthenaOfDelphi :: My Blog :: My Software ::
Thanks Christina, I will take another look at PasDoc
cheers,
Paul
Games:
Seafox
Pages:
Syntax Error Software
itch.io page
Online Chess
http://gameknot.com/#paul_nicholls
Bookmarks