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

Supported types

In addition to support for built in types:

• Object
• Array
• String
• Boolean
• Number

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

Modules

This block should be at the top (under the license) of every JavaScript file:

 /**
  * The Easel Javascript library provides a retained graphics mode for canvas 
  * including a full, hierarchical display list, a core interaction model, and 
  * helper classes to make working with Canvas much easier.
  * @module EaselJS
  */

Classes

/**
 * DESCRIPTION
 * @class CLASS_NAME
 * @static REQUIRED IF CLASS SHOULD NOT BE INSTANTIATED
 **/

Constructor

 /**
 * DESCRIPTION
 * @constructor
 * @param {TYPE} PARAM_NAME DESCRIPTION
 **/

Methods

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

 /**
 * DESCRIPTION
 * @property NAME
 * @static REQUIRED IF PROPERTY IS STATIC
 * @type {TYPE}
 **/

Events

Note, events must be declared after the class declaration for the class they are associated with.

 /**
 * DESCRIPTION
 * @event EVENT_NAME
 * @param {TYPE} NAME DESCRIPTION
 */