Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

[WIP] jsdoc3 for docs #132

Closed
wants to merge 2 commits into from

Conversation

dignifiedquire
Copy link
Contributor

No description provided.

* @param {} files
* @param {object} opts
* @param {function} cb
*/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pros

  • With the code
  • less chance of out of sync

Cons

  • looks like Java

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@dignifiedquire
Copy link
Contributor Author

NO JAVA IN OUR CODE :)

@RichardLitt
Copy link
Contributor

ONLY JAVASCRIPT.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants