Welcome GuestLogin

@syntax token

RSS
Modified on Thursday, 10 December 2009 12:24 by Administrator Categorized as Uncategorized
Specifies the syntax for using a function.

Example


/**
 * Gets an array with specified elements inserted at the beginning.
 * @syntax arrayObj.unshift([item1[, item2 [, ... [, itemN]]]])
 * @arguments {Object} [0-n] Elements to insert at the start of the Array. Optional.
 */
Array.prototype.unshift = function ()
{
}

Description

ECMADoc will generate the function synopsis automatically, based on the function signature and parameter information provided in the documentation. To set a different, custom value to display for a function's synopsis, use the @syntax token. It consists of a single part:

@syntax syntax

  1. The syntax itself. required.
       (The syntax text will be highlighted as JavaScript).

See also

All tokens
@param
@returns
@arguments

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