Added ST_IsEmpty documentation. Related ticket #591.

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

diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml
index 5ea0a20b84f9c0c7970085a9d21d709fe690d60b..5ea81e6442922582d533ee2cbcd3351e7addc099 100644 (file)
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -1583,6 +1583,51 @@ FROM dummy_rast;
                                <para><xref linkend="RT_ST_Raster2WorldCoordX" />, <xref linkend="RT_ST_Raster2WorldCoordY" />, <xref linkend="RT_ST_SRID" /></para>
                        </refsection>
                </refentry>
+
+               <refentry id="RT_ST_IsEmpty">
+                       <refnamediv>
+                               <refname>ST_IsEmpty</refname>
+                               <refpurpose>Returns true if the raster is empty (width = 0 and height = 0). Otherwise, returns false.</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                 <funcprototype>
+                                       <funcdef>boolean <function>ST_IsEmpty</function></funcdef>
+                                       <paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+                                 </funcprototype>
+                           </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                               <title>Description</title>
+                               
+                               <para>Returns true if the raster is empty (width = 0 and height = 0). Otherwise, returns false.</para>
+                       </refsection>
+                               
+                       <refsection>
+                               <title>Examples</title>
+                       
+                               <programlisting>SELECT ST_IsEmpty(ST_MakeEmptyRaster(100, 100, 0, 0, 0, 0, 0, 0))
+st_isempty |
+-----------+
+f          |
+                       
+                        
+SELECT ST_IsEmpty(ST_MakeEmptyRaster(0, 0, 0, 0, 0, 0, 0, 0))
+st_isempty |
+-----------+
+t          |
+
+                </programlisting>      
+                       </refsection>
+               
+                       <!-- Optionally add a "See Also" section -->
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="RT_ST_HasNoBand" /></para>
+                       </refsection>
+               </refentry>
        </sect1>
        
        <sect1 id="RasterBand_Accessors">