JavaDoc & JSDoc don't quite work for turning the source comments into legible HTML documentation. A better approach might be to write a simple parser meself and create something that has a readable structure with the source interspersed as hideable sections (something like rdoc's inline template.)

Readable structure being "things in the order that they should be read in." Which perhaps easiest to achieve through manually writing a documentation page.

Hi there,

I'm very interessed by your work. I did lot of classes for Mootools and I'm trying to learn how to work with your Cake.

I am Perl developper and I will try to generate a working documentation. The Idea is to create an XML wich can be transform to HTML. I'm just reading your sources to check how to generate files.

Hi,

Thanks for the help! You can likely do it by detecting global assignments (Foo = ....) and put the preceding /** */ comment as global documentation and the bits after that as method / function documentation ( bar : ... )

Hi,

You do great work, so I decided to try and generate some docmentation with the jsdoc toolkit. It isn't perfect, but it's better than nothing for at least getting a list of objects available and a basic description of their function. The generated html is attached (you have to look under global).

Hey, that's fantastic. Thank you very much! I'll put it online and link it from the front page.

The next release will be JSDoc compatible, and should represent inheritance correctly. Ilmari, this will also expose a lot of your original comments :)