csnover / js-doc-parse

An experimental library for parsing JavaScript files and extracting inline documentation.
31 stars 7 forks source link

return query(...) // dojo/NodeList not working #58

Closed wkeese closed 12 years ago

wkeese commented 12 years ago

See for example dijit/form/MultiSelect :: getSelected():

getSelected: function(){
    // summary:
    //      Access the NodeList of the selected options directly
    return query("option",this.containerNode).filter(function(n){
        return n.selected; // Boolean
    }); // dojo/NodeList
},

The XML output is listing the type as undefined:

<method name="getSelected" scope="prototype" type="function" from="dijit/form/MultiSelect">
<parameters/>
<return-types>
<return-type type="undefined"/>
</return-types>
<summary>
<p>Access the NodeList of the selected options directly</p>
</summary>
</method>
csnover commented 12 years ago

This is expected. See “Return Value” section at http://dojotoolkit.org/community/styleGuide#Documentation.

wkeese commented 12 years ago

That page is just talking about the description of the return value, not the doc-hint for the type.

But anyway this looks like a dup of #24... that doc-hints for return types aren't working at all.