Functions without a return statement are given a @return tag about sublime-jsdocs

[spadgos]

Do you mean inspecting the body of the function which you're documenting to look at the return statement?

ie, the template inserted would look like this for these functions:

/**
 * [foo description]
 */
function foo() { }

/**
 * [bar description]
 * @return [description]
 */
function bar() {
  return 1;
}

If this is what you mean, then there's no plan to implement that. The plugin simply does some string comparisons against the surrounding code to infer what it can, and I would actually resist any attempt to make it do much more than that. It's not possible to reliably perform this sort of detection without building an entire source tree out of the file -- string comparison obviously can't tell the difference between nested functions, or the word "return" inside a string without getting really complicated. Plus, most of the time while you're editing a file, you don't actually have a valid document which makes a lot of the parsers worthless, since they'd just report a syntax error and die.

So, long story short: adding this sort of functionality is very complicated and couldn't be relied upon most of the time, whereas the alternative is that the developer manually delete a single line. Sorry!

However if I misunderstood the request, please do let me know, and I'd be happy to take another look.

[alexwhitman]

You've understood correctly and I get the complexity of doing it 'properly'.

As a compromise (if the ST2 API makes this any simpler) how about finding the closing brace of the function and checking the line before? If it starts with return then that would be a good indicator. This wouldn't catch return statements in the middle of a function with a fall back to an implicit null return but it would pretty safe to assume that most functions returning something would return as the last thing it does.

[spadgos]

This could possibly work, however it'd be a much larger change to the plugin than I have the time for right now. If you wanted to have a go at it, I'd be happy to accept pull-requests. I guess I see the 'stupidity' of the plugin as a positive thing 😃