Welcome
Guest
•
Login
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
Back
Tokens
Modified on Friday, 11 December 2009 11:14
by
Administrator
Categorized as
Uncategorized
Tokens are one or more lines within an [[Writing documentation|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|parser configuration file]], which does different things for different tokens. The tokens currently supported by ECMADoc are: {| class="wikitable" width="100%" ! Token !! Summary |- | [[Tokens_document|@document]] | Signifies a document comment. |- | [[Tokens_namespace|@namespace]] | Registers a namespace (package) with the parser. |- | [[Tokens_package|@package]] | Registers a namespace (package) with the parser. |- | [[Tokens_type|@type]] | Specifies the type of a property or variable. |- | [[Tokens_param|@param]] | Documents a function parameter. |- | [[Tokens_arguments|@arguments]] | Documents variable number of function parameters. |- | [[Tokens_returns|@returns]] | Documents a function's return value. |- | [[Tokens_event|@event]] | Documents an event that an object raises. |- | [[Tokens_class|@class]] | Classifies a function as a class. |- | [[Tokens_constructor|@constructor]] | Classifies a function as a class. |- | [[Tokens_enum|@enum]] | Classifies an object as an enumeration. |- | [[Tokens_private|@private]] | Classifies a member as private. |- | [[Tokens_see|@see]] | Creates a link to the specified type. |- | [[Tokens_link|@link]] | Creates a link to the specified URL. |- | [[Tokens_author|@author]] | Specifies the author of a section of code. |- | [[Tokens_syntax|@syntax]] | Specifies a member's synopsis. |- | [[Tokens_example|@example]] | Provides an example of using a function or other code. |}
Meta Keywords:
Meta Description:
Change Comment:
ScrewTurn Wiki
version 3.0.4.560. Some of the icons created by
FamFamFam
.