You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
gfwilliams
changed the title
Add module references
Use JSDOC documentation for modules
Mar 10, 2016
Since updating
build.js
, we can now do:and can then add simple documentation to each module in the form of:
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.The text was updated successfully, but these errors were encountered: