-
Notably, the documentation should indicate that node.js users can pass a node Buffer into the `encode` API and that the `decode` API in node.js returns a Buffer.
Ideally this could be done in some …
-
I need to document a decorator with an example, but this breaks the parser because jsdoc2md trying to parse decorators in the example block as jsdoc tag.
```
/**
* type decorator
* @…
-
There's no mention of type in in the output for event (output in jsdoc2md/jsdoc-to-markdown#9 suggests there once was).
Source:
```
/**
* Instance of Test
*
* @constructor
*/
function Test () {
…
-
Maybe it's necessary to create a webpack plugin to do it for me
-
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…
-
If I set `NaN` as a default param value (see param 3 below)...
```
/**
* Example.
*
* @param {number} arg1=1
* @param {number} arg2=something
* @param {number} arg3=NaN
*/
function ex…
-
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…
-
In order to support a grouping globals by category, let's add a `groupGlobalsBy(groupByFields, options)` function. Currently, you can only really group by category if the grouped identifiers are part …
-
A model is a single unit (functions) that performs a particular operation. Models are found in the **/models** directory in the repository. Due to the increase in features of the project more models a…
-
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…