@function

  • constructor
documentjs.tags.function  

Specifies the comment is for a function. Use @param to specify the arguments of a function.

@function [NAME] [TITLE] 

/**
 * @function lib.Component.prototype.update update
 * @parent lib.Component
 */
C.p.update = function(){
     
}

Parameters

  1. NAME {String}Optional

    The name of the function. It should be supplied if it can not be determined from the code block following the comment.

  2. TITLE {String}Optional

    The title to be used for display purposes.

Code Matching

The @function type can be infered from code like the following:

/**
 * The foo function exists
 */
foo: function(){}
/**
 * The bar function exists
 */
bar = function(){}