[Sugar-devel] Javascript API documentation

[Daniel Narvaez]

Hello,

I think we should write a reference for the javascript API as we develop
it. It's always hard to find time to do that after the fact and documenting
it will help to come up with a better API.

Unless someone has alternatives to suggest (I have not spent much time
investigating the topic), we should probably just use YUIdoc. It looks like
a fine tool, it does what we need and it's based on nodejs like every other
tool we are using.

We can setup sugar-build/buildbot to generate the docs and upload them.
Though even before that we can start adding docs to the code using yuidoc
syntax

http://yui.github.io/yuidoc/syntax/index.html


-- 
Daniel Narvaez
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sugarlabs.org/archive/sugar-devel/attachments/20130515/bb27ed25/attachment.html>