[postgis-commits] svn - r2930 - trunk/doc

postgis-commits at postgis.refractions.net postgis-commits at postgis.refractions.net
Sat Aug 23 21:54:34 PDT 2008


Author: kneufeld
Date: 2008-08-23 21:54:33 -0700 (Sat, 23 Aug 2008)
New Revision: 2930

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
moved ST_StartPoint and ST_EndPoint to new reference_new.xml

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-08-22 17:47:05 UTC (rev 2929)
+++ trunk/doc/reference.xml	2008-08-24 04:54:33 UTC (rev 2930)
@@ -376,7 +376,7 @@
           </listitem>
         </varlistentry>
 
-        <varlistentry>
+        <varlistentry id="ST_PointN">
           <term>ST_PointN(geometry,nth integer)</term>
 
           <listitem>
@@ -460,24 +460,6 @@
           </listitem>
         </varlistentry>
 
-        <varlistentry>
-          <term>ST_EndPoint(geometry)</term>
-
-          <listitem>
-            <para>Returns the last point of the LineString geometry as a
-            point.</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry id="StartPoint">
-          <term>ST_StartPoint(geometry)</term>
-
-          <listitem>
-            <para>Returns the first point of the LineString geometry as a
-            point.</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry id="GeometryType">
           <term>GeometryType(geometry)</term>
 
@@ -1973,17 +1955,6 @@
       </varlistentry>
 
       <varlistentry>
-        <term>ST_EndPoint</term>
-
-        <listitem>
-          <para>Return an ST_Point value that is the end point of an ST_Curve
-          value.</para>
-
-          <para>SQL-MM 3: 7.1.4</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term>ST_ExteriorRing</term>
 
         <listitem>
@@ -2325,17 +2296,6 @@
       </varlistentry>
 
       <varlistentry>
-        <term>ST_StartPoint</term>
-
-        <listitem>
-          <para>Return an ST_Point value that is the start point of an
-          ST_Curve value.</para>
-
-          <para>SQL-MM 3: 7.1.3</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term>ST_SymDifference</term>
 
         <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-08-22 17:47:05 UTC (rev 2929)
+++ trunk/doc/reference_new.xml	2008-08-24 04:54:33 UTC (rev 2930)
@@ -1683,6 +1683,64 @@
    
   <sect1>
     <title>Geometry Accessors</title>  
+    
+    <refentry id="ST_EndPoint">
+      <refnamediv>
+        <refname>ST_EndPoint</refname>
+    
+        <refpurpose>Returns the last point of a <varname>LINESTRING</varname>
+        geometry as a <varname>POINT</varname>.</refpurpose>
+      </refnamediv>
+    
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>boolean <function>ST_EndPoint</function></funcdef>
+    
+            <paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+    
+      <refsection>
+        <title>Description</title>
+    
+        <para>Returns the last point of a <varname>LINESTRING</varname> geometry
+        as a <varname>POINT</varname> or <varname>NULL</varname> if the input
+        parameter is not a <varname>LINESTRING</varname>.</para>
+    
+        <para><inlinemediaobject>
+            <imageobject>
+              <imagedata fileref="images/check.png" />
+            </imageobject>
+          </inlinemediaobject> This method implements the SQL/MM specification:
+        SQL-MM 3: 7.1.4</para>
+      </refsection>
+    
+      <refsection>
+        <title>Examples</title>
+    
+        <programlisting>postgis=# SELECT ST_AsText(ST_EndPoint('LINESTRING(1 1, 2 2, 3 3)'::geometry));
+ st_astext
+------------
+ POINT(3 3)
+(1 row)
+
+postgis=# SELECT ST_EndPoint('POINT(1 1)'::geometry) IS NULL AS is_null;
+  is_null
+----------
+ t
+(1 row)</programlisting>
+      </refsection>
+    
+      <refsection>
+        <title>See Also</title>
+    
+        <para><xref linkend="ST_PointN" />, <xref
+        linkend="ST_StartPoint" /></para>
+      </refsection>
+    </refentry>
+
 		<refentry id="ST_Envelope">
 		  <refnamediv>
 			<refname>ST_Envelope</refname>
@@ -1909,6 +1967,7 @@
 		<para><xref linkend="ST_NPoints" /></para>
 	  </refsection>
 	</refentry>
+	
 	<refentry id="ST_SRID">
 	  <refnamediv>
 		<refname>ST_SRID</refname>
@@ -1962,6 +2021,63 @@
 		<para><xref linkend="ST_GeomFromText" />, <xref linkend="ST_SetSRID" />, <xref linkend="ST_Transform" /></para>
 	  </refsection>
 	</refentry>
+	
+	<refentry id="ST_StartPoint">
+    <refnamediv>
+      <refname>ST_StartPoint</refname>
+  
+      <refpurpose>Returns the first point of a <varname>LINESTRING</varname>
+      geometry as a <varname>POINT</varname>.</refpurpose>
+    </refnamediv>
+  
+    <refsynopsisdiv>
+      <funcsynopsis>
+        <funcprototype>
+          <funcdef>boolean <function>ST_StartPoint</function></funcdef>
+  
+          <paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
+        </funcprototype>
+      </funcsynopsis>
+    </refsynopsisdiv>
+  
+    <refsection>
+      <title>Description</title>
+  
+      <para>Returns the first point of a <varname>LINESTRING</varname> geometry
+      as a <varname>POINT</varname> or <varname>NULL</varname> if the input
+      parameter is not a <varname>LINESTRING</varname>.</para>
+  
+      <para><inlinemediaobject>
+          <imageobject>
+            <imagedata fileref="images/check.png" />
+          </imageobject>
+        </inlinemediaobject> This method implements the SQL/MM specification:
+      SQL-MM 3: 7.1.3</para>
+    </refsection>
+  
+    <refsection>
+      <title>Examples</title>
+  
+      <programlisting>postgis=# SELECT ST_AsText(ST_StartPoint('LINESTRING(0 1, 0 2)'::geometry));
+ st_astext
+------------
+ POINT(0 1)
+(1 row)
+
+postgis=# SELECT ST_StartPoint('POINT(0 1)'::geometry) IS NULL AS is_null;
+  is_null
+----------
+ t
+(1 row)</programlisting>
+    </refsection>
+  
+    <refsection>
+      <title>See Also</title>
+  
+      <para><xref linkend="ST_EndPoint" />, <xref linkend="ST_PointN" /></para>
+    </refsection>
+  </refentry>
+
   </sect1>
   
   <sect1>



More information about the postgis-commits mailing list