What is the proper way to document objects of this style in jsdoc:
/**
*/
var strings =
{
/**
*/
stripHTML: function(html)
{
//does something
},
/**
*/
validHTML: function(html)
{
//does something else
}
}
Namely the proper parameter to define the object, and to recognize the sub-functions as part of ‘strings’. I know about @param, @return etc, I just don’t know the main definition for this type of object.
I would use @namespace for “strings”
the methods would simply use @function (though it’s obvious to jsdoc what they are
Edit
In your particular example you may want to use something like:
then used like this: