ECMADoc

• MainPage
  

• Projects
• Namespaces
• Classes
• Visibility
• Events
  

• Type resolving
• Path resolving
• Base files
  

• Parser configuration
• Project configuration
  

• Random Page
• Create a new Page
• All Pages
• Categories
• Navigation Paths
  

• Administration
• File Management
  

@enum token

Classifies an object as an enumeration.

Example

/**
 * Defines the sequence types.
 * @enum
 */
Aeon.AnimationPackage.SequenceType = 
{
    /**
     * Specifies a successive sequence type. 
     */
    SUCCESSIVE: 0,
    /**
     * Specifies a simultaneous sequence type. 
     */
    SIMULTANEOUS: 1
};

Description

Because ECMAScript doesn't provide built-in support of enumerations through the enum keyword, this token can be used to mark designated objects as enumerations.

@enum

This token has no contents. It's sole purpose is to mark an object as an enumeration.

See also

All tokens
@class
@private
@enum