coffeedoc / codo

CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!
Other
625 stars 92 forks source link

Implement optionality marker for @param #204

Closed victorteokw closed 8 years ago

hildjj commented 8 years ago

The node.js API docs are generated with square brackets around the optional parameters. I like that a lot. Something as simple as the description ending in (optional) or starting with Optional, would be perfectly adequate.

mitar commented 8 years ago

Why was this closed? I would also need this feature.

inossidabile commented 8 years ago

Because you can specify "optional" manually and this is not a PR.

mitar commented 8 years ago

But you cannot specify that for the signature.

E-geek commented 8 years ago

Please do not forget the default. Example (as JSDoc param ):

# @param {String} [name] optional value
# @param {Number} [input = 1] optional with default value

Or other format:

# @param {String} name optional value [optional]
# @param {Number} input optional with default value [default = 1]