Is there a specified way to declare a method or a function to return void in JsDoc? Currently I am in the belief that void
is the default return value, and other return values must be specifically provided:
/** * @return {Integer} The identifier for ... */
According to the documentation of Google's Closure Compiler if nothing is being returned, the @return annotation should be omitted.
If there is no return value, do not use a @return tag.
Source: https://developers.google.com/closure/compiler/docs/js-for-compiler#tags
However further documentation also states that the returnType and returnDescription are optional parameters.
returnType - Optional: the type of the return value.
returnDescription - Optional: any additional description.
Source: https://code.google.com/p/jsdoc-toolkit/wiki/TagReturns
You could either leave out the return annotation or include it without any parameters.
I don't believe you have to choose from a set of types in JsDoc... you can use any type name you wish (the curly braces indicate it's a type), so you can simply do:
@return {void}
Although, this is probably more correct for JavaScript:
@return {undefined}
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With