senchalabs/jsduck — Issue #82: Metatags in class members
Author: burnnat
Created: 2011-11-01 12:55:14+00:00
State: open

It looks to me like metatags are only allowable in class root documentation blocks, not any of the class members. Is this the case? I put together a simple file to pass with --meta-tags:

class JsDuck::TodoTag < JsDuck::MetaTag
def initialize
@name = "todo"
@hidden = false
@multiline = true
end

def to_html(text)
puts("TODO:")
puts(text)
return text
end
end

and ran with documentation like this:

/**
* @todo Metadata at the class root.
*/
Ext.define('ExtRM.data.proxy.rm.GatewayPositions', {
/**
* A method that does something.
*
* @todo Metadata for method.
*
* @param {Object} param
* @return {Object}
*/
someMethod: function(param) {
return param;
}
});

But the console output only ever showed "TODO: Metadata at the class root." Seems like metadata tags should be allowed for class members too.