@inner

Содержание

• Обзор
• Примеры
• Связанные ссылки

Обзор

Использование тега @inner пометит символ как внутренний член родительского символа. Это означает, что к нему можно обратиться как "Родитель~Дочерний".

Использование @inner переопределит значение области действия doclet (если он не находится в глобальной области, в этом случае он останется глобальным).

Примеры

/** @namespace MyNamespace */
/**
 * myFunction is now MyNamespace~myFunction.
 * @function myFunction
 * @memberof MyNamespace
 * @inner
 */

Обратите внимание, что в примере выше можно было использовать "@function MyNamespace~myFunction" вместо тегов @memberof и @inner.

/** @namespace */
var MyNamespace = {
    /**
     * foo is now MyNamespace~foo rather than MyNamespace.foo.
     * @inner
     */
    foo: 1
};

В примере выше мы используем @inner, чтобы заставить член пространства имен быть документированным как внутренний член (по умолчанию это статический член). Это означает, что foo теперь имеет полное имя MyNamespace~foo вместо MyNamespace.foo.

Связанные ссылки

• @global
• @instance
• @static