mirror of
https://git.osgeo.org/gitea/postgis/postgis
synced 2024-10-25 09:32:46 +00:00
85 lines
2.8 KiB
XML
85 lines
2.8 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<refentry id="ST_MyMethod">
|
|
<refnamediv>
|
|
<refname>ST_MyMethod</refname>
|
|
|
|
<refpurpose>Returns something useful</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>boolean <function>ST_MyMethod</function></funcdef>
|
|
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
|
|
<paramdef><type>geometry </type> <parameter>g2</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
<!-- 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>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsection>
|
|
<title>Description</title>
|
|
|
|
<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>
|
|
|
|
<para>Availability: version goes here - requires GEOS >= 2.1.0.</para>
|
|
|
|
<!-- Optionally mention OpenGIS compliancy if appropriate -->
|
|
<para><inlinemediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="images/check.png" />
|
|
</imageobject>
|
|
</inlinemediaobject> This method implements the <ulink
|
|
url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple Features
|
|
Implementation Specification for SQL.</ulink></para>
|
|
|
|
<!-- Optionally mention SQL/MM compliancy if appropriate -->
|
|
<para><inlinemediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="images/check.png" />
|
|
</imageobject>
|
|
</inlinemediaobject> This method implements the SQL/MM specification: SQL-MM 3: 5.1.23</para>
|
|
|
|
<!-- Optionally mention 3d support -->
|
|
<para><inlinemediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="images/check.png" />
|
|
</imageobject>
|
|
</inlinemediaobject> This function supports 3d and will not drop the z-index.</para>
|
|
|
|
<!-- Optionally mention Circular String Support -->
|
|
<para><inlinemediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="images/check.png" />
|
|
</imageobject>
|
|
</inlinemediaobject> This method supports Circular Strings and Curves </para>
|
|
</refsection>
|
|
|
|
|
|
<refsection>
|
|
<title>Examples</title>
|
|
|
|
<programlisting></programlisting>
|
|
</refsection>
|
|
|
|
<!-- Optionally add a "See Also" section -->
|
|
<refsection>
|
|
<title>See Also</title>
|
|
|
|
<para><xref linkend="ST_MyMethod2" />, ...</para>
|
|
</refsection>
|
|
</refentry> |