Proper tags for objects in jsdoc

Question

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.

Answer 1

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:

/**
    describe purpose
*/
String.prototype.stripHTML = function()
{
    //does something with this
}

/**
    describe purpose
*/
String.prototype.validHTML = function()
{
    //does something else with this
}

then used like this:

var str = "bob<br/>";
str = str.stripHTML();