1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml: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 role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<!--conditionally specify GEOS minimum version -->
<para role="geos_requirement" conformance="3.9.0">Requires GEOS >= 3.9.0</para>
<!--conditionally specify SFCGAL minimum version -->
<para role="sfcgal_requirement" conformance="1.5.0">Requires SFCGAL >= 1.5.0</para>
<!-- use this format if not a new function but functionality enhanced -->
<para role="enhanced" conformance="2.0.0">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 role="changed" conformance="2.0.0">Changed: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<!-- Optionally mention OpenGIS compliance if appropriate -->
<para>&sfs_compliant;</para>
<!-- Optionally mention SQL/MM compliance 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/>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_MyMethod2"/>, ...</para>
</refsection>
</refentry>
|
