@requires

nene edited this page Mar 21, 2012 · 4 revisions

Synopsis:

@uses ClassName

Defines classes that the documented class requires.

Example:

/**
 * @class Ext.panel.Table
 * Basis of both TreePanel and GridPanel.
 * @requires Ext.selection.RowModel
 * @requires Ext.grid.header.Container
 */

Auto-detection

This tag is auto-detected when class comment is right above Ext.define which contains requires:. The following code is equivalent of the above one:

/**
 * Basis of both TreePanel and GridPanel.
 */
Ext.define("Ext.panel.Table", {
    requires: [
        "Ext.selection.RowModel",
        "Ext.grid.header.Container"
    ]
});

Otherwise the auto-detection behaves just like with @alternateClassName tag.