ac79694824
git-svn-id: http://svn.osgeo.org/postgis/trunk@14960 b70326c6-7e19-0410-871a-916f4a2858ee
100 lines
3.7 KiB
XML
100 lines
3.7 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 with default args -->
|
|
<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>
|
|
|
|
<paramdef choice="opt"><type>varchar </type> <parameter>myparam=the_default_value</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
<!-- example of a spatial aggregate prototype -->
|
|
<!-- If your function is an aggregate, the input for the
|
|
set part eg. set of geometries, should be of type geometry set/geometry set instead of geometry/geography -->
|
|
<funcprototype>
|
|
<funcdef>geometry <function>ST_MyMethod</function></funcdef>
|
|
<paramdef><type>geometry set </type> <parameter>g1</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
<!-- example of a spatial window function prototype -->
|
|
<!-- If your function is window function, the input for the
|
|
set part (the input to the window) eg. set of geometries, should be of type geometry winset/geometry winset instead of geometry/geography -->
|
|
<funcprototype>
|
|
<funcdef>geometry <function>ST_MyMethod</function></funcdef>
|
|
<paramdef><type>geometry winset </type> <parameter>g1</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>
|
|
<!-- use this format if new function -->
|
|
<para>Availability: version goes here - requires GEOS >= 3.3.0. </para>
|
|
|
|
<!-- use this format if not a new function but functionality enhanced -->
|
|
<para>Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
|
|
<!-- use this format if function behavior has changed that could pose backward compatibility issues -->
|
|
<para>Changed: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
|
|
<!-- Optionally mention OpenGIS compliancy if appropriate -->
|
|
<para>&sfs_compliant;</para>
|
|
|
|
<!-- Optionally mention SQL/MM compliancy if appropriate -->
|
|
<para>&sqlmm_compliant; SQL-MM 3: 5.1.40</para>
|
|
|
|
<!-- Optionally mention 3d support -->
|
|
<para>&Z_support;</para>
|
|
|
|
|
|
<!-- Optionally mention Circular String Support -->
|
|
<para>&curve_support;</para>
|
|
|
|
<!-- Optionally mention supports Polyhedral Surface -->
|
|
<para>&P_support;</para>
|
|
|
|
<!-- Optionally mention support for Triangles and TINS -->
|
|
<para>&T_support;</para>
|
|
|
|
<!-- Optionally mention address_standardizer required -->
|
|
<para>&address_standardizer_required;</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>
|