ibm-js / jsdoc-amddcl

An effort to create a JSDoc template that works well with AMD and C3MRO-based multiple class inheritance.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nicer formatting for the doc of optional method arguments

AdrianVasiliu opened this issue · comments

(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.