Autogenerated API documentation

Anastasia Cheetham a.cheetham at utoronto.ca
Mon Feb 23 14:07:38 UTC 2009


On 20-Feb-09, at 5:33 PM, Colin Clark wrote:

> ...Natural Docs is the tool that the MooTools team uses for their  
> documentation
> http://naturaldocs.org/documenting.html


Colin, thanks for this pointer. Natural Docs does look pretty good.

While ease of 'commenting the code for the docs' is very important,  
another thing that I consider important is that the the resulting API  
docs are easy for developers to use. In addition to your thoughts on  
the Natural Docs tool, I'd be very interested to hear what people  
think of the MooTools API documentation that is generated using  
Natural Docs. Obviously, a lot of variation is possible using CSS, but  
the MooTols version can be seen at:

     http://mootools.net/docs/

I will also be investigating other options, and I'll likely be posting  
other links, and asking for more opinions :-)

-- 
Anastasia Cheetham                   a.cheetham at utoronto.ca
Software Designer, Fluid Project    http://fluidproject.org
Adaptive Technology Resource Centre / University of Toronto