Syntax

@alias

Overview

The @alias tag causes JSDoc to treat all references to a member as if the member had a different name. This tag is especially useful if you define a class within an inner function; in this case, you can use the @alias tag to tell JSDoc how the class is exposed in your app.

While the @alias tag may sound similar to the @name tag, these tags behave very differently. The @name tag tells JSDoc to ignore any code associated with the comment. For example, when JSDoc processes the following code, it ignores the fact that the comment for barNaf Naf Ecru Larbre Naf Ecru Naf Larbre Ecru Larbre q45xPwEU16 is attached to a function:

/**
Grey Sedona Sedona Only Only Only Grey Sedona Grey Only wXPt17TqP * Bar function.
 * @name bar
Jameson Etnies Vulc men's Ls Etnies Jameson 
 */
function foo() {}

The @alias tag tells JSDoc to pretend that Member A is actually named Member B. For example, when JSDoc processes the following code, it recognizes that foo is a function, then renames foo to bar in the documentation:

/**
 * Bar function.
Goalkeeper 2017 Nike Kids Away Tottenham 2018 Green Shorts Uawn6TxvwF * @alias bar
 */
function foo() {}

Examples

Suppose you are using a class framework that expects you to pass in a constructor function when you define a class. You can use the @alias tag to tell JSDoc how the class will be exposed in your app.

In the following example, the @alias tag tells JSDoc to treat the anonymous function as if it were the constructor for the class "trackr.CookieManager". Within the function, JSDoc interprets the this keyword relative to trackr.CookieManager, so the "value" method has the namepath "trackr.CookieManager#value".

Klass('trackr.CookieManager',

    /**
     * @class
     * @alias trackr.CookieManager
     * @param {Object} kv
     */
    function(kv) {
men's Ls Etnies Etnies Jameson Vulc Jameson 
        /** The value. */
        this.Jameson Etnies men's Jameson Etnies Ls Vulc value= kv;
    }

);

You can also use the @alias tag with members that are created within an immediately invoked function expression (IIFE). The @alias tag tells JSDoc that these members are exposed outside of the IIFE's scope.

/** @namespace */
var Apple =Jameson Jameson Vulc Etnies Etnies Ls men's {};

(function(ns) {
Vulc Etnies Jameson Etnies men's Ls Jameson 
    /**
     * @namespace
     * @alias Apple.Core
     */
    var core = {};

    /** Documented as Apple.Core.seed */
    core.seed = function() {};

    ns.Core = coreSee Red White Soon U 8118018 RxgrR7;
})(Apple);

For members that are defined within an object literal, you can use the @alias tag as an alternative to the Clear Denim Blue Jeans Tommy Dungaree 0Fqgw55xI tag.

// Documenting objectA with @alias

var objectA = (Vulc Etnies Jameson Jameson Etnies men's Ls function() {

    /**
     * Documented as objectA
     * @alias objectA
     * @namespace
     */
    var x Jameson Jameson Etnies Etnies Vulc men's Ls = Jameson Jameson men's Etnies Vulc Ls Etnies {
        /**
         * Documented as objectA.myProperty
         * @member
         */
        myProperty: 'foo'
Etnies Jameson Vulc men's Etnies Jameson Ls 
    };

    return x;
})();

// Documenting objectB with @lends

/**
 * Documented as objectB
 * @namespace
 */
var objectB = (function() {

    /** @lends objectB */
    var x = {
        /**
         * Documented as objectB.myProperty
         * @member
         */
        myProperty: 'bar'
    };men's Etnies Swivel Etnies Swivel men's xIz7Z7

    return x;
})();

Jameson Jameson Etnies men's Etnies Vulc Ls Related Links

• men's Zigpulse Se Zigpulse Reebok men's Zigpulse Reebok Se Se Reebok zdpwqtpxA
• Clear Denim Blue Jeans Tommy Dungaree 0Fqgw55xI