]> granicus.if.org Git - postgis/commitdiff
Simplify description of TopoElementArray
authorSandro Santilli <strk@keybit.net>
Thu, 11 Oct 2012 17:07:17 +0000 (17:07 +0000)
committerSandro Santilli <strk@keybit.net>
Thu, 11 Oct 2012 17:07:17 +0000 (17:07 +0000)
... and add TopoElement link to See Also section (things are better
explained in there).

git-svn-id: http://svn.osgeo.org/postgis/trunk@10401 b70326c6-7e19-0410-871a-916f4a2858ee

doc/extras_topology.xml

index f887a9dcf7bfc886eea2016541b56e344e0b89b1..5ec2bad95385c8c19c765ce115540a6a6f1f9be7 100644 (file)
@@ -161,13 +161,12 @@ ERROR:  value for domain topology.topoelement violates check constraint "dimensi
                
                <refentry id="topoelementarray">
                  <refnamediv>
-                       <refname>topoelementarray</refname>
-                       <refpurpose>An array of element_id,element_type values. a bidimensional array of integers: '{{id,type}, {id,type}, ...}'</refpurpose>
+                       <refname>TopoElementArray</refname>
+                       <refpurpose>An array of TopoElement objects</refpurpose>
                  </refnamediv>
                  <refsection>
                        <title>Description</title>
-                       <para>An array of 1 or more topoelements ( a bidimensional array of integers: '{{id,type}, {id,type}, ...}').  So an array of 1 or more arrays each having 2 integers generally used to return an array of sets of element id and element type of a topology relation.</para>
-                       <para>For types currrently only 3 types are supported: <varname>node</varname>=1, <varname>edge</varname>=2, <varname>face</varname>=3</para>
+                       <para>An array of 1 or more TopoElement objects, generally used to pass around components of TopoGeometry objects.</para>
                  </refsection>
             <refsection>
                 <title>Examples</title>
@@ -197,7 +196,11 @@ ERROR:  value for domain topology.topoelementarray violates check constraint "di
             <!-- Optionally add a "See Also" section -->
             <refsection>
                 <title>See Also</title>
-                <para><xref linkend="GetTopoGeomElementArray"/>, <xref linkend="TopoElementArray_Agg" /></para>
+                <para>
+<xref linkend="topoelement" />,
+<xref linkend="GetTopoGeomElementArray"/>,
+<xref linkend="TopoElementArray_Agg" />
+                </para>
             </refsection>
                </refentry>
        </sect1>