this is absolute beta, just for testing...

javascript auto documentation

javascript auto documentation is a ruby based application used to generate a documentation for your JavaScript projects.

setup

• Put the right comments in your Javascript file
• Insert your javascript file in "src".
• Edit the Rakefile.
• run "rake doc:create" in the terminal in the root of javascript_auto_document.

The Correct comments:

Every comment should look like this:

/**
 * Js Tabs creates dynamicly javascript tags.
 * @namespace DYNAMICDUDES
 * @class js_tabs
 */

Primary and Secondary Tags

Primary Tags

Each comment should have one of the following tags:

• @module:
  There must be one module per file. By convention, put your module declaration at the top of the file that contains the classes for your module.

• @class:
  The string identifying the functional class on its parent object.

• @constructor:
  The presence of this tag (which requires no description) indicates that this class is instantiable.

• @method:
  The name of a method on the current class.

• @property:
  The name of a property on the current class.

Secondary Tags

Each comment could have one or more of the following tags. Some tags are bind to specific primary tags or secondary tags.

• @for for: @constructor to define on which class the constructor is

• @example for: @constructor
  code example for the constructor

• @namespace
  The namespace of the class

• @param
  Defined as @param name {type} name description, params can be used with classes, methods and events.
  e.g.: @param {DomObject} tabElement The Dom tab element.

• @return
  Defined as @return {type} description.
  e.g.: @return {String} The innerHTML of the div tag.

• @attribute
  An attribute is a managed configuration attribute.

• @default
  The default value of a property, config or attribute.
  e.g.: @default 210

• @config:
  A config is a managed configuration attribute. @config_values {type} name Description
  e.g.: @config {String} class_name Specific an individual class for the wrapper element

• @private for: @method
  If a method is private