Autogenerated API documentation

Colin Clark colin.clark at utoronto.ca
Fri Feb 20 22:33:48 UTC 2009


Now that Infusion 0.8 has shipped, we've decided to move to auto- 
generated API documentation produced from comments inline with the  
code. There a lot of options out there, and I haven't had a chance to  
take a thorough look at them.

Jacob Farber mentioned that Natural Docs is the tool that the MooTools  
team uses for their documentation. After browsing their site for a  
little while, I'm fairly impressed. Natural Docs' philosophy is to  
keep the syntax as simple and readable as possible. Here's what the  
documentation format looks like:

http://naturaldocs.org/documenting.html

Thoughts on this or other documentation formats for APIs?

Colin

---
Colin Clark
Technical Lead, Fluid Project
Adaptive Technology Resource Centre, University of Toronto
http://fluidproject.org




More information about the fluid-work mailing list