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.

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

JSDoc needs better JSDoc comments #839

Open
hegemonic opened this issue Dec 16, 2014 · 1 comment
Open

JSDoc needs better JSDoc comments #839

hegemonic opened this issue Dec 16, 2014 · 1 comment
Labels
Milestone

Comments

@hegemonic
Copy link
Contributor

JSDoc's API documentation is woefully deficient, the irony of which does not escape me. I made the problem much worse by adding dozens of // TODO: docs comments during my JSDoc 3.3 blitz through lib/jsdoc/src.

We should at least have proper documentation for the methods exported by each module. We should also make sure that the docs reflect someone's (my?) idea of JSDoc best practices (for example, "put an asterisk at the start of each line").

@hegemonic hegemonic added this to the 3.4.0 milestone Dec 16, 2014
@hegemonic hegemonic modified the milestones: 4.0, 3.4.0 Oct 21, 2015
@Zearin
Copy link

Zearin commented Oct 13, 2019

I can do some work on this.

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

No branches or pull requests

2 participants