2008-07-15 06:57:32 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
2008-10-16 22:13:08 +00:00
|
|
|
<refentry id="ST_MyMethod">
|
2008-07-15 06:57:32 +00:00
|
|
|
<refnamediv>
|
2008-10-16 22:13:08 +00:00
|
|
|
<refname>ST_MyMethod</refname>
|
2008-07-15 06:57:32 +00:00
|
|
|
|
2008-10-16 22:13:08 +00:00
|
|
|
<refpurpose>Returns something useful</refpurpose>
|
2008-07-15 06:57:32 +00:00
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
<funcsynopsis>
|
|
|
|
<funcprototype>
|
2008-10-16 22:13:08 +00:00
|
|
|
<funcdef>boolean <function>ST_MyMethod</function></funcdef>
|
|
|
|
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
|
|
|
|
<paramdef><type>geometry </type> <parameter>g2</parameter></paramdef>
|
|
|
|
</funcprototype>
|
2008-07-15 06:57:32 +00:00
|
|
|
|
2008-10-16 22:13:08 +00:00
|
|
|
<!-- an optional second method prototype -->
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>boolean <function>ST_MyMethod</function></funcdef>
|
|
|
|
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
|
|
|
|
<paramdef><type>geometry </type> <parameter>g2</parameter></paramdef>
|
|
|
|
<paramdef><type>varchar </type> <parameter>myparam</parameter></paramdef>
|
2008-07-15 06:57:32 +00:00
|
|
|
</funcprototype>
|
|
|
|
</funcsynopsis>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsection>
|
|
|
|
<title>Description</title>
|
|
|
|
|
2008-10-16 22:13:08 +00:00
|
|
|
<para>Some useful description here.</para>
|
|
|
|
|
|
|
|
<!-- optionally mention that this function uses indexes if appropriate -->
|
|
|
|
<note>
|
|
|
|
<para>This function call will automatically include a bounding box
|
|
|
|
comparison that will make use of any indexes that are available on the
|
|
|
|
geometries.</para>
|
|
|
|
</note>
|
2010-08-18 18:48:33 +00:00
|
|
|
<!-- use this format if new function -->
|
|
|
|
<para>Availability: version goes here - requires GEOS >= 3.3.0. </para>
|
2010-08-09 13:53:12 +00:00
|
|
|
|
|
|
|
<!-- use this format if not a new function but functionality was changed or enhanced -->
|
2010-08-18 18:48:33 +00:00
|
|
|
<para>Availability: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
|
2008-10-16 22:13:08 +00:00
|
|
|
<!-- Optionally mention OpenGIS compliancy if appropriate -->
|
2009-11-30 14:30:02 +00:00
|
|
|
<para>&sfs_compliant;</para>
|
2008-07-15 06:57:32 +00:00
|
|
|
|
2008-10-16 22:13:08 +00:00
|
|
|
<!-- Optionally mention SQL/MM compliancy if appropriate -->
|
2009-11-30 14:30:02 +00:00
|
|
|
<para>&sqlmm_compliant; SQL-MM 3: 5.1.40</para>
|
2009-04-27 19:46:45 +00:00
|
|
|
|
2008-10-02 11:40:06 +00:00
|
|
|
<!-- Optionally mention 3d support -->
|
2009-11-30 14:30:02 +00:00
|
|
|
<para>&Z_support;</para>
|
|
|
|
|
2009-04-27 19:46:45 +00:00
|
|
|
|
2008-11-04 01:47:05 +00:00
|
|
|
<!-- Optionally mention Circular String Support -->
|
2009-11-30 14:30:02 +00:00
|
|
|
<para>&curve_support;</para>
|
2010-08-06 12:50:16 +00:00
|
|
|
|
|
|
|
<!-- Optionally mention supports Polyhedral Surface -->
|
|
|
|
<para>&P_support;</para>
|
2010-08-16 14:19:59 +00:00
|
|
|
|
|
|
|
<!-- Optionally mention support for Triangles and TINS -->
|
|
|
|
<para>&T_support;</para>
|
2008-07-15 06:57:32 +00:00
|
|
|
</refsection>
|
2009-04-27 19:46:45 +00:00
|
|
|
|
2008-07-15 06:57:32 +00:00
|
|
|
|
|
|
|
<refsection>
|
|
|
|
<title>Examples</title>
|
|
|
|
|
2008-10-16 22:13:08 +00:00
|
|
|
<programlisting></programlisting>
|
2008-07-15 06:57:32 +00:00
|
|
|
</refsection>
|
2008-07-16 04:54:20 +00:00
|
|
|
|
2008-10-16 22:13:08 +00:00
|
|
|
<!-- Optionally add a "See Also" section -->
|
2008-07-15 06:57:32 +00:00
|
|
|
<refsection>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
2008-10-16 22:13:08 +00:00
|
|
|
<para><xref linkend="ST_MyMethod2" />, ...</para>
|
2008-07-15 06:57:32 +00:00
|
|
|
</refsection>
|
|
|
|
</refentry>
|