Welcome GuestLogin

@param token

RSS
Modified on Thursday, 10 December 2009 12:25 by Administrator Categorized as Uncategorized
Documents a function parameter.

Example


/**
 * Sets the seconds value in the Date object using local time.
 * @param {Number} seconds A numeric value equal to the seconds value.
 * @param {Number} milliseconds A numeric value equal to the milliseconds value.
 */
Date.prototype.setSeconds = function (seconds, milliseconds)

Description

This token documents a function parameter (argument). It consists of four parts:

@param {type} name summary
description

  1. The type of the argument (surrounded with curly braces). Required.
       (Alphanumeric characters including '.' and '$' until a space character)
  2. The name of the argument. Required
       (Alphanumeric characters including '.' and '$' until a space character)
  3. The argument summary. Required.
       (Any characters until the end of the line)
  4. The argument description. Optional.
       (Any characters from the start of the second line until the next token or until the end of the comment).

The three parts are separated by space.

See also

All tokens
@returns
@arguments
@type

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