Re: Documentation - doxygen (was Re: [Plib-devel] Work outstanding.)

[Joel U. <joe...@ya...>]

Sam Stickland wrote:
> 
> > Comments?
> 
> I really would like to suggest doxygen. :)

I tried doxygen, and five other packages, many seemed very buggy -
doxygen crashed. I was impressed with it up to that point (!) But I
couldn't get it to generate docs for me. I didn't spend too long on it -
eventually deciding on using perceps. It is an 80k perl script which
does autogenerated docs. Its used by the ClanLib project. I don't think
it does some of the nifty things the latest doxygen does (from your
sample pages) but it is easy to ship inside your source package,
therefore not adding any dependencies. It also uses style templates to
generate its html - so you can make the manual pages all have the same
look of your choosing.

I agree very much with inline docs - javadoc is lovely (I just started
using it at Uni 2 weeks ago), and with an api as changing as SSg is
right now...

Whatever you choose, I'd be willing to comment any of the ssg classes in
the required style, from the current manual. 

Bye - Joel.