Error while generating doc using example esdoc.json #24
Comments
|
Looks like this is due to parameter destruction, e.g.: subscribe({topic, onNext, onError, onCompleted}) {
return this.observe(topic).subscribe(onNext, onError, onCompleted);
} |
|
yep, so, this function: observe({channel, topic}) {
return this.channel(channel).observe(topic);
}produces this tree: { kind: 'method',
static: false,
variation: null,
name: 'observe',
memberof: 'src/rxmq.js~Rxmq',
longname: 'src/rxmq.js~Rxmq#observe',
access: 'public',
description: null,
lineNumber: 17,
undocument: true,
params: [ { description: undefined } ],
return: { types: [ '*' ], description: undefined },
generator: false,
___id: 'T000002R000031',
___s: true }and as you can see, Trying to figure out why and maybe create a PR. |
|
Interesting thing - if you manually create jsdoc that splits those params into single ones - it compiles OK |
|
@yamalight Hi! Thank you for this issue! This is known ESDoc problem. 😓 With documentation tag, success to build documentation. class Foo {
/**
* @param {{a: string, b: number, c: boolean}} myObject - this is my object.
*/
method({a, b, c}){}
}But if without documentation tag, occur problem to build documentation. class Foo {
method({a, b, c}){}
}Now, workaround is to use Object Param Syntax. |
|
@h13i32maru yup, object params is exactly what I'd used so far. |
|
It's kind of hard to figure out where in your source code the problem arises. If this is not easily fixed, please at least print some helpful information so users can figure out how to avoid the problem. I did exactly that, edited esdoc sources, to figure out. In my case, the error was this: So, I edited and it helped me figure out the problematic sources: |
|
I've got similar problem: added console log on 923 line and got log below hope it will be helpful |
|
Please check latest version. |
So, my config looks like this:
{ "source": "./src", "destination": "./esdoc" }And if I try to run it on blank rxmq project I get the following error:
Any thoughts why that might happen?
Using iojs v2.3.3, npm v.2.12.1
The text was updated successfully, but these errors were encountered: