Changeset 192 for trunk/docs/api

Timestamp:

Apr 27, 2011, 10:27:15 PM (14 years ago)

Author:

jmckenna

Message:

add 'inherits from' missing text

Location:

trunk/docs/api

Files:

• zoo-format-geojson.txt (modified) (1 diff)
• zoo-format-gml.txt (modified) (1 diff)
• zoo-format-json.txt (modified) (1 diff)
• zoo-format-kml.txt (modified) (1 diff)
• zoo-format-wkt.txt (modified) (1 diff)
• zoo-format-wps.txt (modified) (1 diff)
• zoo-geometry-collection.txt (modified) (1 diff)
• zoo-geometry-point.txt (modified) (1 diff)

trunk/docs/api/zoo-format-geojson.txt

@@ -5 +5 @@
 
 Read and write GeoJSON.
+
+Inherits from
+
+- :ref:`ZOO.Format.JSON <api-zoo-format-json>`
 
 Properties      

trunk/docs/api/zoo-format-gml.txt

@@ -5 +5 @@
 
 Read/Write GML.
+
+Inherits from
+
+- :ref:`ZOO.Format <api-zoo-format>`
 
 Properties and Functions        

trunk/docs/api/zoo-format-json.txt

@@ -5 +5 @@
 
 A parser to read/write JSON safely.
+
+Inherits from
+
+- :ref:`ZOO.Format <api-zoo-format>`
 
 Properties      

trunk/docs/api/zoo-format-kml.txt

@@ -5 +5 @@
 
 Read/Write KML.
+
+Inherits from
+
+- :ref:`ZOO.Format <api-zoo-format>`
 
 Properties and Functions        

trunk/docs/api/zoo-format-wkt.txt

@@ -4 +4 @@
 ==============
 
-Class for reading and writing Well-Known Text. 
+Class for reading and writing Well-Known Text.
+
+Inherits from
+
+- :ref:`ZOO.Format <api-zoo-format>`
 
 Functions and Properties        

trunk/docs/api/zoo-format-wps.txt

@@ -5 +5 @@
 
 Read/Write WPS.
+
+Inherits from
+
+- :ref:`ZOO.Format <api-zoo-format>`
 
 Functions and Properties        

trunk/docs/api/zoo-geometry-collection.txt

@@ -4 +4 @@
 =======================
 
-A Collection is exactly what it sounds like: A collection of different Geometries.
+A Collection is exactly what it sounds like: A collection of different Geometries.  
+These are stored in the local parameter :ref:`components <components>` (which can 
+be passed as a parameter to the constructor).
+
+As new geometries are added to the collection, they are NOT cloned.  When removing geometries, 
+they need to be specified by reference (ie you have to pass in the exact geometry to be removed).
+
+The <getArea> and :ref:`getLength <getLength>` functions here merely iterate through the components, 
+summing their respective areas and lengths.
+
+Create a new instance with the :ref:`ZOO.Geometry.Collection <ZOO.Geometry.Collection>` constructor.
+
+Inherits from
+
+- :ref:`ZOO.Geometry <api-zoo-geometry>`
 
 Properties      

trunk/docs/api/zoo-geometry-point.txt

@@ -5 +5 @@
 
 Point geometry class.
+
+Inherits from
+
+- :ref:`ZOO.Geometry <api-zoo-geometry>`
 
 Properties