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

doc: Use jsdoc to document Evolution #591

Open
tahini opened this issue Jul 10, 2024 · 0 comments · May be fixed by #592
Open

doc: Use jsdoc to document Evolution #591

tahini opened this issue Jul 10, 2024 · 0 comments · May be fixed by #592
Labels
documentation Improvements or additions to documentation

Comments

@tahini
Copy link
Contributor

tahini commented Jul 10, 2024

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.

@tahini tahini added the documentation Improvements or additions to documentation label Jul 10, 2024
tahini added a commit to tahini/evolution that referenced this issue Jul 10, 2024
fixes chairemobilite#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`
@tahini tahini linked a pull request Jul 10, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant