search

BoolNordicAB / sharepoint-utilities

Makes client side SharePoint a bit nicer to work with (that's the plan, at least)
https://boolnordicab.github.io/sharepoint-utilities/doc/index.html
MIT License
14 stars 3 forks source link

Should internal functions be documented with jsdoc? #31

Open joladev opened 8 years ago

joladev commented 8 years ago

They are internal, so not intended for end users, but maybe we should do it for consistency?

roobie commented 8 years ago

If they appear in the documentation rendered by jsdoc, then I would say no, otherwise yes.

roobie commented 8 years ago

One can annotate documentation with @ignore if one wants to document an internal function, but still use the jsDoc format of documentation.