Changeset 172 for trunk/docs/api

Timestamp:

Apr 19, 2011, 9:55:41 PM (14 years ago)

Author:

jmckenna

Message:

add missing function details

File:

• trunk/docs/api/zoo-format.txt (modified) (3 diffs)

trunk/docs/api/zoo-format.txt

@@ -51 +51 @@
 
 options 
-  {Object} A reference to options passed to the constructor.
+  ``{Object}`` A reference to options passed to the constructor.
   
 .. _externalProjection:   
 
 externalProjection      
-  {ZOO.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes.
+  :ref:`{ZOO.Projection} <api-zoo-projection>` When passed a externalProjection and internalProjection, 
+  the format will reproject the geometries it reads or writes. The externalProjection is the projection 
+  used by the content which is passed into read or which comes out of write.  In order to reproject, 
+  a projection transformation function for the specified projections must be available.  This support 
+  is provided via zoo-proj4js.
 
 .. _internalProjection:   
 
 internalProjection      
-  {ZOO.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes.
+  :ref:`{ZOO.Projection} <api-zoo-projection>` When passed a externalProjection and internalProjection, 
+  the format will reproject the geometries it reads or writes. The internalProjection is the projection 
+  used by the geometries which are returned by read or which are passed into write.  In order to reproject, 
+  a projection transformation function for the specified projections must be available.  This support 
+  is provided via zoo-proj4js.
 
 .. _data:   
 
 data    
-  {Object} When keepData is true, this is the parsed string sent to read.
+  ``{Object}`` When :ref:`keepData <keepData>` is true, this is the parsed string sent to :ref:`read <read>`.
 
 .. _keepData:   
 
 keepData        
-  {Object} Maintain a reference (data) to the most recently read data.
+  ``{Object}`` Maintain a reference (:ref:`data <data>`) to the most recently read data.  Default is false.
 
 **Functions**
@@ -78 +86 @@
 
 ZOO.Format      
-  Instances of this class are not useful.
+  Instances of this class are not useful.  See one of the subclasses.
+
+  *Parameters*
+  
+  ``options {Object}`` An optional object with properties to set on the format
+  
+  *Valid options*
+
+  ``keepData {Boolean}`` If true, upon read, the data property will be set to the parsed object (e.g. the json or xml object).
+
+  *Returns*
+
+  An instance of ZOO.Format
   
 .. _destroy:     
   
 destroy 
+  ::
+  
+    destroy: function()
+
   Clean up.
 
@@ -88 +112 @@
   
 read    
+  ::
+  
+    read: function(data)
+
   Read data from a string, and return an object whose type depends on the subclass.
+
+  *Parameters*
+  
+  ``data {string}`` Data to read/parse.
+
+  *Returns*
+
+  Depends on the subclass
 
 .. _write:     
 
 write   
+  ::
+  
+    write: function(data)
+
   Accept an object, and return a string.