Automatic JavaScript documentation generation
I'm looking for some recommendations for auto-generating API docs for JS libraries. There doesn't seem to be a lot of info out there on Google, so let's build a list here.
I'm interested in everything from mods to existing packages like DocBook, JavaDocs, etc. to Perl scripts you've stitched together back in 1999. Have at it!
Non-Blogger members can email me and I'll post your link.
6 Comments:
JSDoc is designed for this sort of thing, no?
Dean Edwards forwarded a link to http://www.naturaldocs.org/ as a potential solution as well.
Oops, let's try again: NaturalDocs
whenever i`m republishing my blog it`s showing error -"005 Unable to connect to SFTP server: java.net.ConnectException: Connection refused "
Check out jGrouseDoc - It takes a bit more work to create documentation, since the tool doesn't parse logical structure from code (this is by intent, btw). But it provides a rich in-comment syntax for documenting your design and API, and allows you to document concepts such as inheritance and mixins, classes, structures, and modules. And the next release will have support for modifiers (abstract, static, public, private, protected), which allows you to document design nuances that can't be parsed from code.
The lack of code-parsing may seem to be a detriment at first, but you'll soon discover that the control this affords is well worth the price.
As an added bonus, Denis, the developer, has been very responsive to suggestions and bug reports. (The project is currently hosted on Google Code, with discussion on Google Groups).
Check out jGrouseDoc - It takes a bit more work to create documentation, since the tool doesn't parse logical structure from code (this is by intent, btw). But it provides a rich in-comment syntax for documenting your design and API, and allows you to document concepts such as inheritance and mixins, classes, structures, and modules. And the next release will have support for modifiers (abstract, static, public, private, protected), which allows you to document design nuances that can't be parsed from code.
The lack of code-parsing may seem to be a detriment at first, but you'll soon discover that the control this affords is well worth the price.
As an added bonus, Denis, the developer, has been very responsive to suggestions and bug reports. (The project is currently hosted on Google Code, with discussion on Google Groups).
Post a Comment
<< Home