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

Nicer formatting for the doc of optional method arguments #16

Open
AdrianVasiliu opened this issue Apr 3, 2014 · 0 comments
Open

Nicer formatting for the doc of optional method arguments #16

AdrianVasiliu opened this issue Apr 3, 2014 · 0 comments

Comments

@AdrianVasiliu
Copy link

(minor)
The current output for optional method parameters (say, @param {String|Int} [position] This param does this and that.) looks as follows:

image

It might be nicer to get a more compact output, without adding the “Argument” column, say:

image

Remark: as a matter of fact, such an output can be already obtained using

@param {String|Int} position <i>Optional</i><br/>If reference is a...

that is without using the special JSDoc syntax for optional arguments. But I think this wouldn't be a good solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant