Skip to content
nene edited this page Mar 21, 2012 · 3 revisions

Synopsis:

@private

Documents the visibility of a member as private. Private members may only be used from within the class itself.

In class context it marks the class that's only meant to be used internally by the software package.

Example:

/**
 * Private utility class that manages the internal Shadow cache.
 * @private
 */
Ext.define("Ext.ShadowPool", {
    /**
     * The pool of shadows.
     * @orivate
     */
    shadows: [],

    /**
     * Adds a shadow to the pool.
     */
    push: function(sh) {
        this.shadows.push(sh);
    }
});

See also @protected for documenting members that may also be accessed from subclasses.

Clone this wiki locally