Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the extra "-" if the description already has it #113

Open
LeoAref opened this issue Feb 13, 2017 · 0 comments
Open

Remove the extra "-" if the description already has it #113

LeoAref opened this issue Feb 13, 2017 · 0 comments
Labels
enhancement template Requires a change to a dmd partial/helper

Comments

@LeoAref
Copy link

LeoAref commented Feb 13, 2017

Sometimes the method jsDoc has - (dash) between the variable name and its description, so the generated documentation will has double dashes

For example:

/**
 * Get user full name
 * @param  {string} firstName - First name
 * @param  {string} lastName  - Last name
 * @return {string}           - Full name
 */
function getFullName(firstName, lastName) {
  return firstName + ' ' + lastName;
}

The generated document will looks like:

getFullName() ⇒ string

Get user full name

Kind: global function
Returns: string - - Full name

Param Type Description
firstName string First name
lastName string Last name

The issue is here Returns: string - - Full name

@75lb 75lb added the template Requires a change to a dmd partial/helper label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement template Requires a change to a dmd partial/helper
Development

No branches or pull requests

2 participants