search

pingjiang / cakejs

Automatically exported from code.google.com/p/cakejs
0 stars 0 forks source link

Generate documentation from the source comments #4

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
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.

Original issue reported on code.google.com by Ilmari.H...@gmail.com on 12 Mar 2008 at 5:52

GoogleCodeExporter commented 9 years ago

Original comment by Ilmari.H...@gmail.com on 12 Mar 2008 at 5:53

GoogleCodeExporter commented 9 years ago 
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.

Original comment by Metal3d on 28 Jul 2008 at 9:50

GoogleCodeExporter commented 9 years ago 
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 : ... )

Original comment by Ilmari.H...@gmail.com on 2 Aug 2008 at 3:00

GoogleCodeExporter commented 9 years ago 
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__).

Original comment by illus...@gmail.com on 4 Dec 2008 at 5:02

Attachments:

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

Original comment by Ilmari.H...@gmail.com on 6 Dec 2008 at 9:21

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

Original comment by colin.go...@toystudio.com on 7 Feb 2012 at 5:26