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
I experimented a bit with jsdoc to allow documenting the API of Evolution and its extension mechanisms. It uses the comments on the methods and classes to generate an HTML documentation. Since some parts of our code, especially the extensible ones, are documented and explaining using those tags, we could use jsdoc to produce a human readable documentation for survey developers to read.
This would also highlight the lacks of our doc and encourage us to better document our public facing classes and functions.
The text was updated successfully, but these errors were encountered:
fixeschairemobilite#591
Add yarn scripts to generate documentation for the `evolution-common`
javascript code.
TODO
* Document the typescript code instead, so that the types are also
documented
* Document all the evolution packages, not just `common`
* Provide a higher level "glue" to document high level concepts that can
then link to the jsdoc complete documentation of the packages.
To use this commit, you need to install `jsdoc` globally on your system
with
`npm i -g jsdoc`
I experimented a bit with
jsdoc
to allow documenting the API of Evolution and its extension mechanisms. It uses the comments on the methods and classes to generate an HTML documentation. Since some parts of our code, especially the extensible ones, are documented and explaining using those tags, we could usejsdoc
to produce a human readable documentation for survey developers to read.This would also highlight the lacks of our doc and encourage us to better document our public facing classes and functions.
The text was updated successfully, but these errors were encountered: