Documentation

include MVC MVC.Animate MVC.Class MVC.Controller MVC.Controller.Action MVC.Controller.Action.Drag MVC.Controller.Action.Drop MVC.Controller.Action.EnterLeave MVC.Controller.Action.Event MVC.Controller.Action.Hover MVC.Controller.Action.Lasso MVC.Controller.Action.Selectable MVC.Controller.Action.Subscribe MVC.Controller.Comet MVC.Controller.Params MVC.Controller.Params.Drag MVC.Controller.Params.Drop MVC.Controller.Stateful MVC.Delegator MVC.Doc MVC.Element MVC.Event MVC.File MVC.History MVC.IO MVC.IO.Ajax MVC.IO.Comet MVC.IO.JsonP MVC.IO.WindowName MVC.IO.XDoc MVC.Model MVC.Model.Ajax MVC.Model.Cookie MVC.Model.JsonP MVC.Model.JsonRest MVC.Model.WindowName MVC.Model.XmlRest MVC.Native MVC.Native.Array MVC.Native.Date MVC.Native.Function MVC.Native.Number MVC.Native.Object MVC.Native.String MVC.Options MVC.Store MVC.SyntheticEvent MVC.Test MVC.Test.Assertions MVC.Test.Controller MVC.Test.Functional MVC.Test.Runner MVC.Test.Unit MVC.Timer MVC.Timer.Easings MVC.Vector MVC.View MVC.View.Helpers OpenAjax

MVC.Doc.Constructor

Inherits: MVC.Doc.Pair
Documents javascript constructor classes typically created like: new MyContructor(args).

A constructor can be described by putting @constructor as the first declaritive. To describe the construction function, write that after init. Example:

 /* @constructor
  * Person represents a human with a name 
  * @init 
  * You must pass in a name.
  * @params {String} name A person's name
  *|
 Person = function(name){
    this.name = name
    Person.count ++;
 }
 /* @Static *|
 MVC.Object.extend(Person, {
    /* Number of People *|
    count: 0
 })
 /* @Prototype *|
 Person.prototype = {
   /* Returns a formal name 
    * @return {String} the name with "Mrs." added
    *|
   fancy_name : function(){
      return "Mrs. "+this.name;
   }
 }


Static Methods

Prototype Methods

init

init(comment, code, scope) -> undefined
{Object} -
{Object} -
{Object} -

signiture

signiture() -> undefined
Returns the HTML signiture of the constructor function.