-
## Description
Change the documentation step `build:docs` in `bindings/wasm/package.json` to include custom Typescript definitions in the generated `bindings/wasm/docs/api-reference.md` file.
## M…
-
In NodeJs version 23, running this command against any file...
```
$ jsdoc -X index.js
```
...fails with this output
```
jsdoc-issue lloyd:$ npx jsdoc -X index.js
(node:67669) Experiment…
-
Any time I get an error generating the markdown, it's usually something like this:
```
$ jsdoc2md file.js > file.md
JSDOC_ERROR: ERROR: Unable to parse file.js: Unexpected token {
```
Is there …
-
I have tried using JSDoc 3's `@tutorial` with `jsdoc-to-markdown` with no success.
I'm trying to extract common documentation in an npm package and include parts in other packages. I'm using `@tuto…
-
I didn't find any configurations for this, is it possible that jsdoc doesn't provide this function?
-
Might sound confusing by the title, so I'll try to explain myself. When I do `@param {string} [myVar = '']`, the output becomes `"''"`. I just do a find and replace every time I make a change to the d…
-
I found it useful to parse the `api.json` and pull out the `route -> method -> function name` and dump it in the readme.md of a project. This doesn't have to be baked into shep, but I figured I'd open…
-
## What
Once we're happy with the format and location, we should work out how to automatically generate the JavaScript API Reference from JSDoc at build time, rather than hand-writing it and manual…
-
I have a class that extends another one. Is it possible for the child class to include documentation for inherited methods? I'm only getting documentation for the actual methods in the class and not t…
-
I am manually adding the API Reference to the website. This is okay for now but will eventually need to be extracted from comments in the source. We have JSDocs for generating a documentation website …