Changeset 177 for trunk/docs

Timestamp:

Apr 20, 2011, 12:00:57 AM (14 years ago)

Author:

jmckenna

Message:

add missing function details

File:

• trunk/docs/api/zoo-projection.txt (modified) (2 diffs)

trunk/docs/api/zoo-projection.txt

@@ -49 +49 @@
 
 proj    
-  {Object} Proj4js.Proj instance.
+  ``{Object}`` Proj4js.Proj instance.
   
 .. _projCode:     
   
 projCode        
-  {String}
+  ``{String}``
 
 **Functions**
@@ -63 +63 @@
   This class offers several methods for interacting with a wrapped zoo-pro4js projection object.
 
+  *Parameters*
+  
+  | ``projCode {String}`` A string identifying the Well Known Identifier for the projection.
+  | ``options {Object}`` An optional object to set additional properties.
+
+  *Returns*
+
+  :ref:`{ZOO.Projection} <api-zoo-projection>` A projection object.
+  
 .. _getCode:     
 
 getCode 
+  ::
+  
+    getCode: function()
+
   Get the string SRS code.
+  
+  *Returns*
+
+  ``{String}`` The SRS code. 
   
 .. _getUnits:       
 
 getUnits        
+  ::
+  
+    getUnits: function()
+
   Get the units string for the projection -- returns null if zoo-proj4js is not available.
 
+  *Returns*
+
+  ``{String}`` The units abbreviation.
+  
 .. _toString:       
 
 toString        
+  ::
+  
+    toString: function()
+
   Convert projection to string (getCode wrapper).
+  
+  *Returns*
+
+  ``{String}`` The projection code.  
   
 .. _equals:         
   
 equals  
-  Test equality of two projection instances.
+  ::
+  
+    equals: function(projection)
+
+  Test equality of two projection instances.  Determines equality based soley on the projection code.
+
+  *Returns*
+
+  ``{Boolean}`` The two projections are equivalent. 
   
 .. _destroy:           
   
 destroy 
-  Destroy projection object.
+  ::
+  
+    destroy: function()
+
+  Destroy projection object. 
   
 .. _transform:             
   
 transform       
-  Transform a point coordinate from one projection to another. 
+  ::
+  
+    ZOO.Projection.transform = function(point,source,dest)
+
+  Transform a point coordinate from one projection to another.  Note that the input point is 
+  transformed in place.
+  
+  *Parameters*
+  
+  | ``point {{ZOO.Geometry.Point> | Object}`` An object with x and y properties representing coordinates in those dimensions.
+  | ``sourceProj {ZOO.Projection}`` Source map coordinate system
+  | ``destProj {ZOO.Projection}`` Destination map coordinate system
+
+  *Returns*
+  
+  ``point {object}`` A transformed coordinate.  The original point is modified.