bscotch / stitch

Tools and apps for GameMaker development: a CLI for pipeline development, a VSCode extension for coding, and more.
Other
119 stars 13 forks source link

Function name hover card displays double hyphen when provided in description #93

Closed bfrymire closed 1 year ago

bfrymire commented 1 year ago

According to JSDocs:

You can add a hyphen before the description to make it more readable. Be sure to include a space before and after the hyphen.

When hovering over a function name where a parameter definition has the optional hyphen before the description, the hover card will display a double-hyphen. I'm expecting only a single hyphen to be displayed.

Code_FvRVDq2MKi

Example code:

/**
 * My first function!
 * @function helloWorld
 * @param {String} [_name="World"] - The name of the person to greet.
 * @returns {String} A greeting for the supplied name.
 */
function helloWorld(_name="World") {
    return "Hello, " + _name + "!";
}
adam-coster commented 1 year ago

Ah, yep, should be an easy fix!

adam-coster commented 1 year ago

This will be resolved in the next release!