Welcome GuestLogin

@private token

RSS
Modified on Sunday, 20 December 2009 18:12 by Administrator Categorized as Uncategorized
Classifies a member as private.

Example


/**
 * Initializes this instance
 * @private
 * @param {Shape} instance The instance to initialize
 */
Circle.prototype.initializeInstance = function Circle$initializeInstance(instance)
{
}

Description

Because ECMAScript 3 and lower doesn't provide built-in support for specifying visibility through the private keyword and related constructs, this token is used to mark designated members as private. Note that ECMADoc will automatically consider as private any members that are clearly private to the scope in which they are defined. However if an otherwise public member should be considered private (for instance to discourage its use from outside) this token can be used.

@private

This token has no contents. It's sole purpose is to mark a member as a private.

See also

All tokens
Visibility
@class
@enum

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