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
  

Tokens

Tokens are one or more lines within an ECMADoc comment that begin with the name of the token, prefixed with an 'at' (@) symbol. Each token is assigned a token handler in the parser configuration file, which does different things for different tokens.

The tokens currently supported by ECMADoc are:

Token	Summary
@document	Signifies a document comment.
@namespace	Registers a namespace (package) with the parser.
@package	Registers a namespace (package) with the parser.
@type	Specifies the type of a property or variable.
@param	Documents a function parameter.
@arguments	Documents variable number of function parameters.
@returns	Documents a function's return value.
@event	Documents an event that an object raises.
@class	Classifies a function as a class.
@constructor	Classifies a function as a class.
@enum	Classifies an object as an enumeration.
@private	Classifies a member as private.
@see	Creates a link to the specified type.
@link	Creates a link to the specified URL.
@author	Specifies the author of a section of code.
@syntax	Specifies a member's synopsis.
@example	Provides an example of using a function or other code.