-
FYI jsdoc2md dev dependency sends usage statistics with no opt-out -- would recommend using https://github.com/documentationjs/documentation instead. I used it to generate API docs for `@zhealth/style…
-
### Summary
jsdoc tags `@file` and its synonims `@overview` and `@fileoverview` seem to be ignored by `jsdoc-to-markdown`
#### Steps to reproduce
Create a file with the following contents:
``` js
'…
-
I have the following js (`simple.js`):
```
/**
* foo!
* @category A
*/
function foo(){}
/**
* bar!
* @category A
*/
function bar(){}
/**
* baz!
* @category B
*/
function baz(){}
/**
* fo…
-
Create a plugin that generates API section using jsdoc comments
This package might be used https://github.com/jsdoc2md/jsdoc-to-markdown
-
When I add a `@file` comment to a file, it doesn't show in the Markdown.
Example:
```js
/**
* @file This is my file comment.
*/
/**
* This is my funciton.
*/
function a() {
}
```
…
-
- [x] Create `spectcl.github.io` repo
- [ ] Auto-generate docs for io repo using `jsdoc2md` so that our API docs are kept up-to-date with the code being merged.
-
See: https://github.com/jsdoc2md/jsdoc-to-markdown/issues/188
-
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 () {
…
-
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 …
-
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…