Welcome GuestLogin

Tokens

RSS
Modified on Friday, 11 December 2009 11:14 by Administrator Categorized as Uncategorized
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:

TokenSummary
@documentSignifies a document comment.
@namespaceRegisters a namespace (package) with the parser.
@packageRegisters a namespace (package) with the parser.
@typeSpecifies the type of a property or variable.
@paramDocuments a function parameter.
@argumentsDocuments variable number of function parameters.
@returnsDocuments a function's return value.
@eventDocuments an event that an object raises.
@classClassifies a function as a class.
@constructorClassifies a function as a class.
@enumClassifies an object as an enumeration.
@privateClassifies a member as private.
@seeCreates a link to the specified type.
@linkCreates a link to the specified URL.
@authorSpecifies the author of a section of code.
@syntaxSpecifies a member's synopsis.
@exampleProvides an example of using a function or other code.

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