Welcome GuestLogin

@document token

RSS
Modified on Sunday, 20 December 2009 17:23 by Administrator Categorized as Uncategorized
Signifies a document comment.

Example


/**
 * @document
 * @namespace adventureworks
 * @namespace adventureworks.utils
 */

Description

The sole purpose of the document tag is to signify that a comment block applies to the document itself. One use of this documentation block is to provide a placeholder for adding @namespace tokens to register namespaces.

The document token otherwise acts just like other EcmaDoc comments, so any lines of text from the beginning of the comment to the first token apply to the document itself. However, note that no documentation is generated for documents at this time.

See also

All tokens
@namespace

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