documentation

documentation copied to clipboard

@returns object only support text, it does not provide a default return value formatted with code

2

I have been trying to use `@returns` with an object and write the documentation. I always get the same output, for instance: ``` * @returns {Object} result - The result...

kopax

Cannot use "require" within @example in TypeScript files

2

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

rdmurphy

Missing optional properties indication in Comment entity

3

I'm using `documentation.build()` method (NodeJS API) to generate "comments", which I use to build custom HTML. After the update from `10.0.0` -> `10.1.0` (which adds "_TypeScript support & inference_") `documentation.build`...

skyiea

TypeScript support crashing on valid TS files

3

We've been using documentation.js for https://github.com/keybase/keybase-bot for a while and up until our migration to TypeScript it worked perfectly. I'm currently trying to get it running once again and I'm...

pzduniak

HTTPS support for documentation serve

1

* What version of documentation.js are you using?: ```bash $ grep '"version"' node_modules/documentation/package.json "version": "11.0.1" ``` * How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): `npx...

candu

Update anchorjs

1

would be good to update to the latest version of anchor.js for the default_theme. REF: https://github.com/bryanbraun/anchorjs/releases Shall I open a PR with the updated script? `https://github.com/bryanbraun/anchorjs/blob/master/anchor.js`

coliff

Empty documentation if file is all exports

4

Input code ``` export {combine} from './combine' export {sample} from './sample' export type {Domain} from 'effector/domain' export {createDomain} from 'effector/domain' export type {Event} from 'effector/event' export { createEvent, forward, fromObservable,...

goodmind

@param should have final say if a parameter is optional or has a default

2

A the moment, this: ```js /** * An example. * @param {Object} options Options. * @param {FooOptions} options.fooOptions Foo options. * @param {BarOptions} options.barOptions Bar options. */ const example =...

jaydenseric

Better flow type support for complex types

12

As far as I can see the current flow type support doesn't support the use of the actual type definition. For example: ``` /** * A ComplexType with some properties...

philippotto

Object declarations omit default values

2

**If you're reporting a bug, please include _input code_, _output documentation_, a description of what you expected to happen, and what happened instead.** Given the following input: ``` /** *...

webOS101