[WIP] jsdoc3 for docs #132
Conversation
| * @param {} files | ||
| * @param {object} opts | ||
| * @param {function} cb | ||
| */ |
There was a problem hiding this comment.
How does everyone feel about this JavaDoc'ization in order to have docs?
It is nice to have API docs, not sure if, since we have to write them anyway, if we prefer to right them on the readme with examples or add this to all of the function calls.
There was a problem hiding this comment.
Pros
- With the code
- less chance of out of sync
Cons
- looks like Java
There was a problem hiding this comment.
There was a problem hiding this comment.
Jsdoc is pretty sweet, I just get annoyed at it because you end up with truly massive js files. It definitely helps out documentation, though, and I've used it before.
The only real con is that updating it can get old. but not as old as old docs.
There was a problem hiding this comment.
my opinion: in general, while in other languages I do like godoc, i find that most successful modules I use in javascript are very small, easy to use, and have the docs/examples directly in the readme. i typically run away from jsdoc-ed modules.
|
NO JAVA IN OUR CODE :) |
|
ONLY |
No description provided.