Documentation

We are currently in the process of switching from JSDoc to YUI Doc for documentation generation.

Yui Doc Documentation

• Official Yui Documentation
• Building Documentation with YUI Doc Slides
• Building Documentation Yui Doc Video and Transcript

Below is information not covered in the official documentation.

Supported types

In addition to support for built in types:

• Object
• Array
• String
• Boolean
• Number

You can also specify custom types, such as {Point}

Methods

 /**
 * DESCRIPTION
 * @method METHOD_NAME
 * @static REQUIRED IF METHOD IS STATIC
 * @param {TYPE} PARAM_NAME DESCRIPTION
 * @return {TYPE} DESCRIPTION
 **/