Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide valid documentation #16

Closed
fgm opened this issue Nov 28, 2016 · 1 comment
Closed

Provide valid documentation #16

fgm opened this issue Nov 28, 2016 · 1 comment
Assignees
@fgm
Labels
enhancement
Milestone
Merge back to VR

Comments

@fgm
Copy link
Owner

fgm commented Nov 28, 2016 •
edited
Loading

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.
@fgm fgm added this to the Merge back to VR milestone Nov 28, 2016
@fgm fgm self-assigned this Nov 28, 2016
fgm added a commit that referenced this issue Nov 28, 2016
@fgm
Issue #16: provide consistent API documentation.
653111c
fgm added a commit that referenced this issue Nov 28, 2016
@fgm
Merge pull request #17 from FGM/16-jsdoc
63e631f 
Issue #16: provide consistent API documentation.
@fgm
Copy link
Owner Author

fgm commented Nov 28, 2016

Fixed in merged PR #17

@fgm fgm closed this as completed Nov 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fgm fgm

Labels
enhancement
Projects
None yet
Milestone
Merge back to VR
Development

No branches or pull requests
1 participant
@fgm