jsdoc-user

[Jsdoc-user] jsdoc finds function declarations in constant string

[Ilya M. <ma...@gm...>]

Hi everyone,
I'm stuck with a problem using jsdoc.
In my code there's a part like this:
/**
* Internal use
* @ignore
*/
this.dummy = "... function dummy_function1 ... function dummy_function2
...."

I have variables which contain parts of a code.
The problem is that jsdoc finds all those function declarations in a
constant strings and includes them into the document... :(
I need to ignore all what's in static strings, and I don't know how to do it
properly...

I can see an ugly way to do it - write something like:
this.dummy = "... fun"+"ction dummy_function1 ..."
It helps, but I don't really think it's a nice solving.

Can anyone suggest anything better?

Thanks in advance

P.S. I'm using jsdoc 1.10.2

Re: [Jsdoc-user] jsdoc finds function declarations in constant string

[Gabriel R. <gab...@gm...>]

Hi,

> /**
>  * Internal use
>  * @ignore
>  */
> this.dummy = "... function dummy_function1 ... function dummy_function2
> ...."
>
> I have variables which contain parts of a code.
> The problem is that jsdoc finds all those function declarations in a
> constant strings and includes them into the document... :(
> I need to ignore all what's in static strings, and I don't know how to do it
> properly...
>
> I can see an ugly way to do it - write something like:
> this.dummy = "... fun"+"ction dummy_function1 ..."
> It helps, but I don't really think it's a nice solving.
>
> Can anyone suggest anything better?

This is definitely a bug in JSDoc (which isn't really being actively
maintained these days). I'll try to post a fixed version for this in
the next few days, but failing that, I would suggest you check out the
Jsdoc Toolkit (www.jsdoc.info). It is a lot more powerful and flexible
than JSDoc, and it will certainly not suffer from this bug.

Regards,

Gabriel