Option to omit @return if no type given

[glifchits]

I find it redundant to include the @return {undefined} for the many functions I have which do not have a return type. Can this be implemented?

[heavenshell]

Is let g:jsdoc_return = 0 solve your problem?

[glifchits]

No because I would still like to include the @return type, but only if it is not undefined. What do you think?

[heavenshell]

humm, Sorry I still don't understand what is your requirement.

but only if it is not undefined
So, what do you want to generate?

Just only @return?
And why @return {undefined} is redundant.

[glifchits]

When I am prompted for the return type, if I type nothing, there should be no @return tag at all. (Currently, it will add @return {undefined}.)

Note that I can still type undefined for the return type, and then it will add @return {undefined}.

If you believe this is a silly request then please feel free to close it. I admit this is a matter of personal preference and therefore it might not be worth implementing it in this plugin.

[faceleg]

I'd like this feature. Saves me from having to go back and delete unwanted @return lines

[glifchits]

After closer investigation, I think this is in fact a bug.

let g:jsdoc_return=1
let g:jsdoc_allow_input_prompt=1

I press Ctrl+L. I get prompts for the arguments...

Argument "argName" type: number
Argument "argName" description: description

Finally I get

Return type (blank for no @return):

I press Enter and then the documentation string appears:

/**
 * functionName
 *
 * @param {number} argName description
 * @return {undefined}
 */

Even though I left it blank, it still generated a @return {undefined}, which is not what the prompt indicated.

[heavenshell]

@glifchits Thx I'll look into your PR this week end.

[ryanoasis]

👍 At first I didn't quite agree but that's just because I am used to how it works now 😛

But this change does seem to make sense given how the prompt reads 😸

[heavenshell]

@glifchits LGTM thx, merged.