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

Use JSDOC documentation for modules #84

Open
gfwilliams opened this issue Jul 15, 2014 · 1 comment
Open

Use JSDOC documentation for modules #84

gfwilliams opened this issue Jul 15, 2014 · 1 comment

Comments

@gfwilliams
Copy link
Member

Since updating build.js, we can now do:

Reference
--------------

* APPEND_JSDOC: modulename.js

and can then add simple documentation to each module in the form of:

/** My description
 second line if we want it */
FooBar.prototype.hello = function() {
}

/** Another */
exports.woot = function() {
}

See devices/NRF24L01P.js as an example. We now just need to bash through all the modules and do this.

Note that it doesn't cope with defining functions inside an export.connect function. Ideas for how to sort that appreciated - but for now it can just be documented in a comment above.

@gfwilliams gfwilliams changed the title Add module references Use JSDOC documentation for modules Mar 10, 2016
@gfwilliams
Copy link
Member Author

If anyone notices a module that could use this and feels like updating it, it'd really be appreciated.

@gfwilliams gfwilliams pinned this issue Feb 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant