MVC.Doc API

MVC.Doc, static, link, link_content, objects

JavaScriptMVC comes with powerful and easy to extend documentation functionality - MVC Doc. MVC Doc is designed specifically for documenting JavaScript. It understands a little about JavaScript syntax to guess at things like function names and parameters. But, you can also document complex functionality across multiple files.

MVC Doc is pure JavaScript so it is easy to modify and make improvements. First, lets show what MVC Doc can document:

@attribute - values on an object.
@function - functions on an object.
@constructor - functions you call like: new Thing()
@class - normal JS Objects and source that uses MVC.Class

You can also specifify the scope of where your functions and attributes are being added with:

@prototype - add to the previous class or constructor's prototype functions
@static - add to the previous class or constructor's static functions
@add - add docs to a class or construtor described in another file

Finally, you have directives that provide addtional info about the comment:

Example

The following documents a Person constructor.

 /* @constructor
  * 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 = 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;
   }
 }

There are a few things to notice:

The example closes comments with *|. You should close them with / instead of |.
We create a link to another class with [Animal | here].

Using with a JavaScritpMVC application

By default, compression will automatically document your code. Simply compress your application with:

js apps/app_name/compress.js

The docs will be put in your docs folder.

Using without JavaScriptMVC

This process will be made easier in the future. But you have to create a js file using application that looks like this:

 //loads doc source
 load('jmvc/rhino/documentation/setup.js'); 
 //pass file locations, and a name to a new Doc.Application
 new MVC.Doc.Application(['file1.js','folder/file2.js'], "MyApp");

Static Methods

link

link(content) -> undefined

Will replace with a link to a class or function if appropriate.

content {Object} -

link_content

link_content(content) -> undefined

Replaces content in brackets [] with a link to source.

content {String} - Any text, usually a commment.

objects

A map of the full name of all the objects the application creates and the url to the documentation for them.

Documentation