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

Optional parameters and default values in jsdoc #70

Open
AlexanderZeilmannTNG opened this issue May 28, 2014 · 0 comments
Open

Optional parameters and default values in jsdoc #70

AlexanderZeilmannTNG opened this issue May 28, 2014 · 0 comments

Comments

@AlexanderZeilmannTNG
Copy link

I modified (see this commit) some jsdoc related parts to support optional parameters and default values.
Optional parameters can be written like this:

/**
 * @param {number} [optionalParameter] Description
 */

And an optional parameter with default value like this:

/**
 * @param {number} [withDefault=42] Description
 */

I also fixed a bug where a "-" between the parameter name and description was interpreted as bullet point. (The dash is allowed in jsdoc to improve readability.)

/**
 * @param {number} parameterName - Description
 */

Furthermore I moved the description of a parameter (and of return values) in the html output to a new line to improve readability.

If you want I can send a pull request and/or change something.

@jbt jbt mentioned this issue Aug 3, 2015
8 tasks
jbt added a commit that referenced this issue Dec 13, 2015
Also fix the .map(path.basename) thing. Closes #89
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant