jsdoc

jsdoc copied to clipboard

### Input code Doc comments using `@default` will produce bogus `defaultvalue` values when the value is an object literal: ```javascript /** * words * @config {type} * @default */ sorters...

dongryphon

Kenwolf1962

JSDoc duplicating method names is documentation API

1

### Input code ```js ** * * @memberOf module:Foo * @class Bar * */ export class Bar { /** * * @memberOf module:Foo.Bar * * @param {any} req * @param...

BNdabwunze

Means of distinguishing (experimental) object rest properties

2

### Input code ```js /** * @param {PlainObject} cfg * @param {number} cfg.num * @param {PlainObject} cfg.extra */ export function quux ({num, ...extra}) { // } ``` ### Expected behavior...

brettz9

How to document @property having spaces in name

21

As title, I am trying to document an object using @typedef and @property, for example: ```js /** * @typedef {object} theObj * @property Prop 1 {string} property one */ const...

vcshox

escape character sequence in comment?

12

Since jsdoc use `/** */`, it is difficult to include regex pattens, e.g. `/.*/` I try to escape the `*` character by using `/.\u002A/`, but the output is exactly the...

inno-v

Inline syntax

9

As suggested at https://github.com/tc39/proposal-type-annotations/issues/202#issuecomment-1833797860, I have a proposal for a minimal inline syntax for types. The idea is to consider any comment where the first token is a JsDoc token...

piranna

How to extend a typedef parameter in JSDOC?

39

Description: http://stackoverflow.com/questions/36737921/how-to-extend-a-typedef-parameter-in-jsdoc

julkue

Mixin fields are documented twice on class declarations with a constructor

3

### Input code ```js /** * @mixes Mixin */ class MyClass { constructor() { } } /** * @mixin */ const Mixin = { /** * A field */ field:...

deiwin

Let's assume I have a project containing multiple namespaces. Is there a way of generating documentation only for a specific namespace? My idea is to extract a public part of...

rgembalik