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 & improved site docs #26

Closed
MattIPv4 opened this issue Jun 8, 2019 · 0 comments

Comments

Projects
None yet
1 participant
@MattIPv4
Copy link
Owner

commented Jun 8, 2019

Feature request

Feature description

The plugin needs to be fully documented with jsdoc in the code (this can be made an ESLint rule). Further, the site should not only document the options but all public methods for an instance of the class and also any static methods.

How the feature is useful

Allow contributors to understand how everything works internally far more easily and enable any developer using the plugin to far more easily understand the controls.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.