Welcome GuestLogin

@class token

RSS
Modified on Thursday, 10 December 2009 12:30 by Administrator Categorized as Uncategorized
Classifies a function as a class.

Example


/**
 * Implements a basic shape.
 * @class
 */
function Shape()
{
}

Description

Because ECMAScript 3 and lower doesn't provide built-in support of classes through the class keyword and related constructs, this token is used to mark designated functions as classes. Note that ECMADoc will automatically consider as classes any functions that define custom prototype members. In case ECMADoc fails to recognize a function as a class, this token can be used.

@class

This token has no contents. It's sole purpose is to mark a function as a class.

See also

All tokens
Classes
@private
@enum

ScrewTurn Wiki version 3.0.4.560. Some of the icons created by FamFamFam.