Escaping needs to occur for hyperlinked content

[intel352]

Optional parameters are not properly escaped when a hyperlink is generated.

Ex:

/**
 * Contact class
 * @param {Customer} [customer] Customer object
 * @param {Profile} [profile] Profile object
 * @constructor
 * @alias module:models/contact~Contact
 */
function Contact(customer, profile) {

Some resulting markdown (invalid, no hyperlink as a result):

    * [new Contact([customer], [profile])](#markdown-header-new-contactcustomer-profile)

Markdown that works:

    * [new Contact(\[customer\], \[profile\])](#markdown-header-new-contactcustomer-profile)

Notice the escaping of the nested square brackets

[intel352]

@75lb @windgazer any chance one of you could suggest where this change should be made?

[75lb]

does it help if you swap the param name and type around, like this?

@param [customer] {Customer} Customer object

Is sig-link.hbs the partial which generates the output in question?

[intel352]

@75lb it was my guess as well that sig-link.hbs is the file that generates the output.

Swapping the param/type doesn't change the end result, links are still generated the same way, with the optional parameters (optional designated by square brackets) not being escaped, which causes links to fail.

[75lb]

OK.. i'm tied up on another release atm so it might be time to debug this plugin or create your own.