enhance @config to support optional properties about jsdoc-toolkit

[GoogleCodeExporter]

The [name] syntax is only valid for @params. This would be a feature request to 
add it to @config as well.

Original comment by micmath on 16 Oct 2007 at 8:10

• Added labels: Priority-Low, Type-Enhancement
• Removed labels: Priority-Medium, Type-Defect

[GoogleCodeExporter]

Original comment by micmath on 16 Oct 2007 at 8:33

• Changed state: Accepted

[GoogleCodeExporter]

In point of fact, the documentation located at:

http://code.google.com/p/jsdoc-toolkit/wiki/DocExamples

... under "Parameters" has an example with optional config parameters.  I just 
noticed this enhancement, after I submitted my bug based on this documentation.

The enhancement code is contained within my bug report.  Please let me know if 
the 
fix is appropriate!  For now, I'm going to keep that source change local to 
support 
my needs.

Original comment by clintandrewhall on 15 Nov 2007 at 5:15

[GoogleCodeExporter]

Have you tried this in version 1.4? I ran the example from 
http://code.google.com/p/jsdoc-toolkit/wiki/DocExamples 
using 1.4.0b and it seems to work for me.

That example should better be:

/**
 * Modify the details of the employee.
 * @param {object} employee The employee.
 * @param {object} newDetails
 * @config {string} [title] The new job title.
 * @config {number} salary The new salary.
 */
function modify(employee, newDetails) {
    if (newDetails.title != undefined)  employee.title = newDetails.title;
    employee.salary = newDetails.salary;
}

Where newDetails is a configuration object with a required property and an 
optional property.

Original comment by micmath on 15 Nov 2007 at 7:59

[GoogleCodeExporter]

Closed due to lack of feedback from submitter. Feel free to reopen if this is 
still considered a valid bug.

Original comment by micmath on 21 Dec 2007 at 6:52

• Changed state: Invalid