documentation

documentation copied to clipboard

fix: Update scope to default to static when memberof fix #197

lcharbon

markdown_ast include comment.kind in heading (for each node)

2

Markdown output won't include anything that clearly reveals the kind of a named item. You have to analyse the output (by looking at the naming or at the displayed subheadings)...

adroste

Is there any particular way to document overloaded constructor? For example, I would like to document the following constructor: ``` class Pokemon{ /** * @param {Object} options - some options...

DigitalBrainJS

Instance members of objects within a namespace not in correct section

5

It seems as though instance members of a class/object within a namespace are not organized correctly on the output documentation. I am running the very latest commit to date: https://github.com/documentationjs/documentation/commit/f07285a9200162908efa5dfc3076cb32d1425c6e...

bpatram

@file is applied to following element instead of the file itself

1

If you use the `@file` statement to provide a description for your file in a header, it gets applied as a duplicate block to whichever element comes first in the...

Malvineous

NODE_API.md does not to indicate support for .yml configuration, but I can?

1

Was reading the the docs, and wanted to make use of the configuration mentioned [here](https://github.com/documentationjs/documentation/blob/master/docs/CONFIG.md), with the nodejs apis. But, I couldn't find any mention of it in the [nodejs...

lukwallace

**If you're reporting a bug, please include _input code_, _output documentation_, a description of what you expected to happen, and what happened instead.** * What version of documentation.js are you...

ggrossetie

**If you're reporting a bug, please include _input code_, _output documentation_, a description of what you expected to happen, and what happened instead.** When I use `@param` and wrongly put...

yvesgurcan

Add typescript examples

2

Partial typescript support was added in https://github.com/documentationjs/documentation/pull/1234, but there are no documentation or examples of usage. Adding some example would be very helpful.

SkeLLLa

Flow type issue

1

Hi. I am using the latest version of **documentation.js.** Please check the screenshot shown below. Generated HTML doesn't show valid input Flow types and return Flow type if I use...

4zuko