-
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…
-
There doesn't appear to be any documentation regarding the use of plugins. It turns out there is a `--plugin` flag which can activate specific plugins. However, I cannot figure out how options are sen…
-
**Describe the issue**
From the TypeScript documentation: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
We can use class constructors in params:
```javascript
/**
*…
-
ESLint has JSDoc validation, but [only if you don't have a newline between the JSDoc block and the function def](https://github.com/segmentio/eslint-config/blob/373b79c4794dec6290576114697393b92d811b3…
-
I noticed eslint has a plugin that verifies jsdoc. Should we evaluate it for potential PhET usage?
https://github.com/gajus/eslint-plugin-jsdoc/blob/master/README.md
-
Javascript in ES modules with a .mjs file extension are not supported by jsdoc. This is the new extension that's going to be promoted by NodeJS, and already supported by libraries like `@std/esm` for …
-
Functions with types like `function(number):boolean` are only rendered as the single word "function".
Using Closure compiler syntax for function annotations: https://github.com/google/closure-c…
-
When generating documentation for a class that extends another, and the base class has it's constructor documented, JSDoc generates duplicated documentation pages for the class that is being extended.…
-
Hello `prettier-plugin-jsdoc` devs! Thank you very much for all the hard work on this great tool. Our team is beginning to use it, and we encountered an issue that is partially with prettier itself an…
-
I think It would be great to have a tag marking the stability level of a module or its parts.
We do have `@version` but that is really meant or numbers, and I can only imagine using it for an entir…