@ignore

nene edited this page Mar 21, 2012 · 1 revision

Synopsis:

@ignore

Completely ignores a class or member.

When used on class the whole class together with all its members will be removed from documentation.

When used on member the doc-comment is parsed as usual, but is then thrown away and not added to any class.

Example:

/**
 * The actual implementation.
 * @ignore
 */
function foo() {
}

return {
  /**
   * Here are the actual docs for #foo.
   */
  foo: function() {
    foo.apply(this, arguments);
  }
}
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.