JavaScript autoblock doesn't add return value about docblockr HOT 8 CLOSED

This is the output i get when i run.
Can you please be more specific and point out the error, gif or screenshot would be helpful

/**
 * [get_function_return_type description]
 * @param  {[type]} name   [description]
 * @param  {[type]} retval [description]
 * @return {[type]}        [description]
 */
DocsParser.prototype.get_function_return_type = function(name, retval) {
    return 123;
};

from docblockr.

I am having the same issue, and seem to have narrowed down the problem. Both function expressions and declarations do not get a return value in the doc block if the name contains a capital letter.

This gets a return value in the doc block:

var a = function () {
   return;
};

This doesn't:

var A = function () {
   return;
};

This doesn't either:

var aA = function () {
   return;
};

from docblockr.

I'm getting the same issue in PHP:

Lower-case method name:

    /**
     * [dosomething description]
     *
     * @param [type] $xray [description]
     * @param array $yankee [description]
     * @param [type] $zulu [description]
     *
     * @return [type] [description]
     */
    public function dosomething($xray, array $yankee = array(), $zulu)
    {
        return 1;
    }

Method name containing an upper-case character:

    /**
     * [doSomething description]
     *
     * @param [type] $xray [description]
     * @param array $yankee [description]
     * @param [type] $zulu [description]
     */
    public function doSomething($xray, array $yankee = array(), $zulu)
    {
        return 1;
    }

from docblockr.

I'm getting the exact same results as @chriscollinsboxuk in PHP.

from docblockr.

Ditto, in JS.

from docblockr.

The offending method is DocsParser.prototype.get_function_return_type: https://github.com/NikhilKalige/docblockr/blob/master/lib/docsparser.js#L202

It's trying to infer a return type.

if(name.search(/[A-Z]/) > -1)
        return null;  // no return, but should add a class

is the statement causing it to fail.

Anybody have any thoughts on what this method should actually be checking for?

from docblockr.

From the README:

In Javascript, if the function begins with an uppercase letter then it is assumed that the function is a class definition. No @return tag is added.

search() returns the index of the first match, so if set our condition to only match for the 0th index then it won't trigger for caps throughout the function name. This should fix it:

- if(name.search(/[A-Z]/) > -1)
+ if(name.search(/[A-Z]/) === 0)

PR here: #91

from docblockr.

merged for next release thx

from docblockr.