search

csnover / js-doc-parse

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

comment on line declaring export variable masks summary #66

Closed wkeese closed 12 years ago

wkeese commented 12 years ago

dojo/_base/array.js had:


var array = {                        // the export object
    // summary:
    //      The Javascript v1.6 array extensions.
    ...
};
...

return array;

Yet for some reason the summary didn't end up in the details.xml file.

Same for dojo/_base/unload.

csnover commented 12 years ago

what’s with the // the export object comment on the previous line? i wouldn’t be surprised if that was causing the dojodoc processor to think that it’s not a dojodoc block and to ignore it.

wkeese commented 12 years ago

Cool, getting rid of the comment works around the problem. There was no special purpose to the comment, just an explanation of what the array variable was.

csnover commented 12 years ago

I don’t think this is really a bug in the parser, it’s intentional, designed to avoid when someone does something like:

// blah blah blah, blah blah
// blah blah, something etc.
// TODO: Finish this