hacklab/strudel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add hideDescription flag to JsDoc

Browse source
This commit is contained in:
Felix Roos 2023-01-07 22:11:47 +01:00
parent 3992356517
commit 5733e00908
2 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
website/src/pages/technical-manual/docs.mdx
View file

@ -47,6 +47,7 @@ Usage:
- `name`: function name, as named with `@name` in jsdoc
- `h`: level of heading. `0` will hide the heading. Hiding it allows using a manual heading which results in a nav link being generated in the right sidebar.
- `hideDescription`: if set, the description will be hidden
### Writing jsdoc