Provide valid documentation
fgm opened this issue · comments
Currently the code contains a number of JSdoc comments, but they are not validated by providing an actual buildable documentation. Add one.
After checking Docco, Yuidoc, Jsdoc, Docstrap and the meteor-jsdoc fork, the standard is going to be Jsdoc with Docstrap: meteor-jsdoc is really for apps, not NPM modules. Docco basically just splits the comments from inline to side-by-side with code, Yuidoc needs too much extra jsdoc-like markup, and Docstrap is just a set of plugins on top of jsdoc, the most interesting one being search.
Fixed in merged PR #17