mad4milk archive
Mootools gets his documentation
October 23 2006, 02:09:00
As revision 82 commits in, mootools got all the files, classes, functions, methods highly documented.
I think we all need to say a big thank you to Aaron Newton, a cnet editor javascript evangelist who made all the documentation in the first place, later polished and fixed by myself.
We used naturaldocs to document mootools, a cool method to document projects with inline comments. The only downfall is that the source files are much bigger now, but this is no big deal, since you can already download the source compressed, stripped of all its comments (documentation included). I also plan to add an option later to remove only documentation from the download.
I only wish naturaldocs didnt have to put that javascript inside! Also, creating the docs stylesheet took away about 6 hours of my life that I’ll never get back. Dont get me wrong, naturaldocs is a great documentation software, probably the best one out there. It’s just a templating engine away from being perfect.
But other features are online…
Yes, I had a lot of fun this weekend.
I also added a mootools forum, based on bbpress. I had an hard time customizing it to add vital functionalities like gravatars (so vital), colourized code and integration with the bugs and suggestions reports. But in the end, it was worth the pain.
Thats it for now! And what do you say about mootools? Has it been useful for you? Did you find any quirks? Dont be shy, the comment box is here for you, and I’m here to listen, be it in the comments, by mail or in the forum.