Add new tag @config about jsdoc-toolkit

[GoogleCodeExporter]

Original comment by micmath on 10 Aug 2007 at 7:38

• Changed state: Accepted
• Added labels: Type-Enhancement
• Removed labels: Type-Defect

[GoogleCodeExporter]

Original comment by micmath on 11 Aug 2007 at 1:50

• Changed state: Started

[GoogleCodeExporter]

Added in release 186.

Original comment by micmath on 12 Aug 2007 at 10:54

• Changed state: Fixed

[GoogleCodeExporter]

Hello micmath.

Thanks a lot for the work and for the speed.

I have seen a little bug when there is a parameter with @param before @config, 
the
first item of config is prefixed with the name of @param.

Is it a bug or a bad use of the fonctionnality?


Thanks again

Regards Alex

Original comment by [email protected] on 13 Aug 2007 at 6:00

[GoogleCodeExporter]

Not a bug Alex, that is by design. The idea is that @config is used to document
properties of parameters, so if you have a parameter named foo, and you expect 
there
to be a bar property of that foo, then we are documenting foo.bar.

function Example(foo) {
    this.bar = foo.bar;
}

If you must document a constructor that takes a normal parameter first and then 
a
configuration object second, you can just do this:

/**
 * @param p A normal parameter
 * @param foo A configuration object.
 * @config bar A property of foo that is required.
 */
function Example(p, foo) {
    this.p = p;
    this.bar = foo.bar;
}

Original comment by micmath on 13 Aug 2007 at 6:24

[GoogleCodeExporter]

Hi

I agree with you. So the problem is when you have more than one @config. The 
first
has the good prefix (name of parameter) but other have the prefix "config". They
should have the name of the parameter as the first.

Regards Alex

Original comment by [email protected] on 13 Aug 2007 at 6:32