jsdoc-parse

jsdoc-parse copied to clipboard

Restore class names of default-exported modules

2

This is an attempt to resolve the downstream issue I just filed, https://github.com/jsdoc2md/jsdoc-to-markdown/issues/270 - see that issue for more details, but the short is, if we're parsing the following file:...

cincodenada

**eg.** ``` /** * some doc * @type {boolean} */ static modeChangeEnabled ``` **is** name:"modeChangeEnabled" longname:"**Camera#modeChangeEnabled**" kind:"member" memberof:"Camera" scope:"**instance**" **but should be** name:"modeChangeEnabled" longname:"**Camera.modeChangeEnabled**" kind:"member" memberof:"Camera" scope:"**static**" ps. I am...

ghost

Constructor documentation is ignored unless description or @param is included

3

I ran into [this](https://github.com/jsdoc2md/jsdoc-to-markdown/issues/73) issue where `@example` tags on class docs get ignored if a description (tagless description or `@description` -- not `@classdesc`) is not included. Based on [this line](https://github.com/jsdoc2md/jsdoc-parse/blob/master/lib/transform.js#L126)...

afsmith92

Add support for @hideconstructor. Remove constructor when this JSDoc attribute is defined on a class.

rogeru

Fix: es6 constructor docs generation (fixes #33)

4

This fixes addresses the [linked issue](https://github.com/jsdoc2md/jsdoc-parse/issues/33): ```javascript /** * @class LinkedList * * @example * const linkedList = new LinkedList(); */ class LinkedList { ``` jsdoc-parse currently ignores the example...

afsmith92

How to comment entire file using @file

1

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...

Anthony-Gaudino