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.Class

Author: Jupiter IT
Inherits: MVC.Doc.Pair
Documents a 'Class'. A class is typically a collection of static and prototype functions. MVC Doc can automatically detect classes created with MVC.Class. However, you can make anything a class with the @class ClassName directive.
 /**
  * Person represents a human with a name.  Read about the 
  * animal class [Animal | here].
  * @init 
  * You must pass in a name.
  * @params {String} name A person's name
  *|
 Person = Animal.extend(
 /* @Static *|
 {
    /* Number of People *|
    count: 0
 },
 /* @Prototype *|
 {
    init : function(name){
      this.name = name
      this._super({warmblood: true})
    },
    /* Returns a formal name 
    * @return {String} the name with "Mrs." added
    *|
   fancy_name : function(){
      return "Mrs. "+this.name;
   }
 })

Static Methods

init

init() -> undefined
Loads the class view.

Prototype Methods

add_parent

add_parent(scope) -> undefined
Adds this class to the file it was created in.
{MVC.Doc.Pair} -

cleaned_comment

cleaned_comment() -> undefined
Returns a comment that has been cleaned.

comment_setup_complete

comment_setup_complete() -> undefined
Verifies the class was created successfully.
get_quicklinks() -> undefined
Creates links to functions and attributes in this class.

init

init(comment, code, scope) -> undefined
Called when a new class comment is encountered.
{String} - the comment text
{String} - the first line of source following the comment
{MVC.Doc.Pair} - where the class was created, typically the file

toFile

toFile(left_side) -> undefined
Renders this class to a file.
{String} - The left side content / list of all documented classes & constructors.

url

url() -> String
Returns the url for this page
{String} -