Changeset 168 for trunk/docs

Timestamp:

Apr 19, 2011, 8:56:17 PM (14 years ago)

Author:

jmckenna

Message:

add missing function details

File:

• trunk/docs/api/zoo.txt (modified) (1 diff)

trunk/docs/api/zoo.txt

@@ -84 +84 @@
 
 removeItem      
-  Remove an object from an array.
+  ::
+  
+    removeItem: function(array,item)
+  
+  Remove an object from an array.  Iterates through the array to find the item, then removes it.
+  
+  *Parameters*
+  
+  | ``array {Array}``
+  | ``item {Object}``
+  
+  *Returns*
+   
+  ``{Array}`` A reference to the array
   
 .. _indexOf:
 
 indexOf 
+  ::
+  
+    indexOf: function(array,obj)
+
+  *Parameters*
+   
+  | ``array {Array}``
+  | ``obj {Object}``
+
+  *Returns*
+
+  ``{Integer}`` The index at, which the first object was found in the array.  If not found, returns -1.
 
 .. _extend:
 
 extend
-  Copy all properties of a source object to a destination object.
+  ::
+  
+    extend: function(destination,source)
+
+  Copy all properties of a source object to a destination object.  Modifies the passed in destination object.  
+  Any properties on the source object that are set to undefined will not be (re)set on the destination object.
+
+  *Parameters*
+  
+  | ``destination {Object}`` The object that will be modified
+  | ``source {Object}`` The object with properties to be set on the destination
+
+  *Returns*
+
+  ``{Object}`` The destination object.
   
 .. _rad:  
   
 rad     
+  ::
+  
+    rad: function(x)
+
+  *Parameters*
+  
+  | ``x {Float}``
+
+  *Returns*
+
+  ``{Float}``
 
 .. _distVincenty:
 
-distVincenty    
-  Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid.
+distVincenty
+  ::
+
+    distVincenty: function(p1,p2)
+
+  Given two objects representing points with geographic coordinates, this calculates the distance between 
+  those points on the surface of an ellipsoid.
+
+  *Parameters:*
+
+  | ``p1`` :ref:`{ZOO.Geometry.Point} <zoo-geometry-point>` (or any object with both .x, .y properties)``
+  | ``p2`` :ref:`{ZOO.Geometry.Point} <zoo-geometry-point>` (or any object with both .x, .y properties)
 
 .. _Class:
 
 Class   
-  Method used to create ZOO classes.
+  ::
+  
+    Class: function()
+
+  Method used to create ZOO classes.  Includes support for multiple inheritance.
   
 .. _UpdateStatus:  
   
 UpdateStatus    
+  ::
+  
+    UpdateStatus: function(env,value)
+
   Method used to update the status of the process
 
+  *Parameters*
+  
+  | ``env {Object}`` The environment object
+  | ``value {Float}`` The status value between 0 to 100
+