|
4 | 4 | #include "euler.h" |
5 | 5 |
|
6 | 6 | /* |
7 | | - * ! \file \brief Spherical circle declarations |
| 7 | + * Spherical circle declarations |
8 | 8 | */ |
9 | 9 |
|
10 | 10 | /* |
11 | | - * ! \brief Spherical circle. |
| 11 | + * Spherical circle data structure: center and radius. |
12 | 12 | */ |
13 | 13 | typedef struct |
14 | 14 | { |
15 | | - SPoint center; |
16 | | - /* !<the center of circle */ |
17 | | - float8 radius; |
18 | | - /* !<the circle radius in radians */ |
| 15 | + SPoint center; /* the center of circle */ |
| 16 | + float8 radius; /* the circle radius in radians */ |
19 | 17 | } SCIRCLE; |
20 | 18 |
|
21 | 19 | /* |
22 | | - * ! \brief Checks whether two circles are equal. \param c1 pointer to first |
23 | | - * circle \param c2 pointer to second circle \return true, if equal |
| 20 | + * Checks whether two circles are equal. |
24 | 21 | */ |
25 | 22 | bool scircle_eq(const SCIRCLE *c1, const SCIRCLE *c2); |
26 | 23 |
|
27 | 24 | /* |
28 | | - * ! \brief checks whether circle contains point \param p pointer to point |
29 | | - * \param c pointer to circle \return true, if circle contains point |
| 25 | + * Checks whether circle contains point. |
30 | 26 | */ |
31 | 27 | bool spoint_in_circle(const SPoint *p, const SCIRCLE *c); |
32 | 28 |
|
33 | 29 | /* |
34 | | - * ! \brief transforms a circle using Euler transformation \param out pointer |
35 | | - * to transformed circle \param in pointer to circle \param se pointer to |
36 | | - * Euler transformation \return pointer to transformed circle |
| 30 | + * Transforms a circle using Euler transformation. |
37 | 31 | */ |
38 | 32 | SCIRCLE *euler_scircle_trans(SCIRCLE *out, const SCIRCLE *in, const SEuler *se); |
39 | 33 |
|
40 | 34 | /* |
41 | | - * ! Takes the input and stores it as spherical circle. \brief a circle input |
42 | | - * function \return a spherical circle datum \note PostgreSQL function |
| 35 | + * Takes the input and stores it as spherical circle. |
43 | 36 | */ |
44 | 37 | Datum spherecircle_in(PG_FUNCTION_ARGS); |
45 | 38 |
|
46 | 39 | /* |
47 | | - * ! Checks whether two circles are equal. \brief equality of two circles |
48 | | - * \return boolean datum \note PostgreSQL function |
| 40 | + * Checks whether two circles are equal. |
49 | 41 | */ |
50 | 42 | Datum spherecircle_equal(PG_FUNCTION_ARGS); |
51 | 43 |
|
52 | 44 | /* |
53 | | - * ! Checks whether two circles are not equal. \brief Checks whether two |
54 | | - * circles are not equal \return boolean datum \note PostgreSQL function |
| 45 | + * Checks whether two circles are not equal. |
55 | 46 | */ |
56 | 47 | Datum spherecircle_equal_neg(PG_FUNCTION_ARGS); |
57 | 48 |
|
58 | 49 | /* |
59 | | - * ! Calculate the distance of two circles. If overlapping, this function |
60 | | - * returns 0.0. \brief distance of two circles \return float8 datum \note |
61 | | - * PostgreSQL function |
| 50 | + * Calculate the distance of two circles. If overlapping, this function |
| 51 | + * returns 0.0. |
62 | 52 | */ |
63 | 53 | Datum spherecircle_distance(PG_FUNCTION_ARGS); |
64 | 54 |
|
65 | 55 | /* |
66 | | - * ! Calculate the distance of circle and point. If circle contains point, |
67 | | - * this function returns 0.0. \brief distance of circle and point \return |
68 | | - * float8 datum \note PostgreSQL function \see |
69 | | - * spherecircle_point_distance_com(PG_FUNCTION_ARGS) |
| 56 | + * Calculate the distance of circle and point. If circle contains point, |
| 57 | + * this function returns 0.0. |
70 | 58 | */ |
71 | 59 | Datum spherecircle_point_distance(PG_FUNCTION_ARGS); |
72 | 60 |
|
73 | 61 | /* |
74 | | - * ! Calculate the distance of point and circle. If circle contains point, |
75 | | - * this function returns 0.0. \brief distance of point and circle \return |
76 | | - * float8 datum \note PostgreSQL function \see |
77 | | - * spherecircle_point_distance(PG_FUNCTION_ARGS) |
| 62 | + * Calculate the distance of point and circle. If circle contains point, |
| 63 | + * this function returns 0.0. |
78 | 64 | */ |
79 | 65 | Datum spherecircle_point_distance_com(PG_FUNCTION_ARGS); |
80 | 66 |
|
81 | 67 | /* |
82 | | - * ! \brief Checks whether circle contains point \return boolean datum \note |
83 | | - * PostgreSQL function |
| 68 | + * Checks whether circle contains point. |
84 | 69 | */ |
85 | 70 | Datum spherepoint_in_circle(PG_FUNCTION_ARGS); |
86 | 71 |
|
87 | 72 | /* |
88 | | - * ! \brief Checks whether circle doesn't contain point \return boolean datum |
89 | | - * \note PostgreSQL function |
| 73 | + * Checks whether circle doesn't contain point. |
90 | 74 | */ |
91 | 75 | Datum spherepoint_in_circle_neg(PG_FUNCTION_ARGS); |
92 | 76 |
|
93 | 77 | /* |
94 | | - * ! \brief Checks whether circle contains point \return boolean datum \note |
95 | | - * PostgreSQL function |
| 78 | + * Checks whether circle contains point. |
96 | 79 | */ |
97 | 80 | Datum spherepoint_in_circle_com(PG_FUNCTION_ARGS); |
98 | 81 |
|
99 | 82 | /* |
100 | | - * ! \brief Checks whether circle doesn't contain point \return boolean datum |
101 | | - * \note PostgreSQL function |
| 83 | + * Checks whether circle doesn't contain point. |
102 | 84 | */ |
103 | 85 | Datum spherepoint_in_circle_com_neg(PG_FUNCTION_ARGS); |
104 | 86 |
|
105 | 87 | /* |
106 | | - * ! \brief Checks whether circle is contained by other circle \return |
107 | | - * boolean datum \note PostgreSQL function |
| 88 | + * Checks whether circle is contained by other circle. |
108 | 89 | */ |
109 | 90 | Datum spherecircle_in_circle(PG_FUNCTION_ARGS); |
110 | 91 |
|
111 | 92 | /* |
112 | | - * ! \brief Checks whether circle is not contained by other circle \return |
113 | | - * boolean datum \note PostgreSQL function |
| 93 | + * Checks whether circle is not contained by other circle. |
114 | 94 | */ |
115 | 95 | Datum spherecircle_in_circle_neg(PG_FUNCTION_ARGS); |
116 | 96 |
|
117 | 97 | /* |
118 | | - * ! \brief Checks whether circle contains other circle \return boolean datum |
119 | | - * \note PostgreSQL function |
| 98 | + * Checks whether circle contains other circle. |
120 | 99 | */ |
121 | 100 | Datum spherecircle_in_circle_com(PG_FUNCTION_ARGS); |
122 | 101 |
|
123 | 102 | /* |
124 | | - * ! \brief Checks whether circle does not contain other circle \return |
125 | | - * boolean datum \note PostgreSQL function |
| 103 | + * Checks whether circle does not contain other circle. |
126 | 104 | */ |
127 | 105 | Datum spherecircle_in_circle_com_neg(PG_FUNCTION_ARGS); |
128 | 106 |
|
129 | 107 | /* |
130 | | - * ! \brief Checks whether two circle overlap \return boolean datum \note |
131 | | - * PostgreSQL function |
| 108 | + * Checks whether two circle overlap. |
132 | 109 | */ |
133 | 110 | Datum spherecircle_overlap(PG_FUNCTION_ARGS); |
134 | 111 |
|
135 | 112 | /* |
136 | | - * ! \brief Checks whether two circle overlap \return boolean datum \note |
137 | | - * PostgreSQL function |
| 113 | + * Checks whether two circle overlap. |
138 | 114 | */ |
139 | 115 | Datum spherecircle_overlap_neg(PG_FUNCTION_ARGS); |
140 | 116 |
|
141 | 117 | /* |
142 | | - * ! \brief returns the center of circle \return spherical point datum \note |
143 | | - * PostgreSQL function |
| 118 | + * Returns the center of circle. |
144 | 119 | */ |
145 | 120 | Datum spherecircle_center(PG_FUNCTION_ARGS); |
146 | 121 |
|
147 | 122 | /* |
148 | | - * ! \brief returns the radius of circle \return float8 datum \note |
149 | | - * PostgreSQL function |
| 123 | + * Returns the radius of circle. |
150 | 124 | */ |
151 | 125 | Datum spherecircle_radius(PG_FUNCTION_ARGS); |
152 | 126 |
|
153 | 127 | /* |
154 | | - * ! \brief converts a point to a circle \return spherical circle datum \note |
155 | | - * PostgreSQL function |
| 128 | + * Converts a point to a circle. |
156 | 129 | */ |
157 | 130 | Datum spherepoint_to_circle(PG_FUNCTION_ARGS); |
158 | 131 |
|
159 | 132 | /* |
160 | | - * ! \brief Creates a circle from center and radius \return spherical circle |
161 | | - * datum \note PostgreSQL function |
| 133 | + * Creates a circle from center and radius. |
162 | 134 | */ |
163 | 135 | Datum spherecircle_by_center(PG_FUNCTION_ARGS); |
164 | 136 |
|
165 | 137 | /* |
166 | | - * ! Calculates the area of a circle in square radians \brief calculate the |
167 | | - * area of a circle \return float8 datum \note PostgreSQL function |
| 138 | + * Calculates the area of a circle in square radians. |
168 | 139 | */ |
169 | 140 | Datum spherecircle_area(PG_FUNCTION_ARGS); |
170 | 141 |
|
171 | 142 | /* |
172 | | - * ! Calculates the circumference of a circle in radians. \brief calculate |
173 | | - * the circumference of a circle \return float8 datum \note PostgreSQL |
174 | | - * function |
| 143 | + * Calculates the circumference of a circle in radians. |
175 | 144 | */ |
176 | 145 | Datum spherecircle_circ(PG_FUNCTION_ARGS); |
177 | 146 |
|
178 | 147 | /* |
179 | | - * ! Transforms a circle using Euler transformation \brief transforms a |
180 | | - * circle \return spherical circle datum \note PostgreSQL function |
| 148 | + * Transforms a circle using Euler transformation. |
181 | 149 | */ |
182 | 150 | Datum spheretrans_circle(PG_FUNCTION_ARGS); |
183 | 151 |
|
184 | 152 | /* |
185 | | - * ! Invers transformation of a circle using Euler transformation \brief |
186 | | - * inverse transformation of a circle \return spherical circle datum \note |
187 | | - * PostgreSQL function |
| 153 | + * Inverse transformation of a circle using Euler transformation. |
188 | 154 | */ |
189 | 155 | Datum spheretrans_circle_inverse(PG_FUNCTION_ARGS); |
190 | 156 |
|
191 | | - |
192 | | - |
193 | 157 | #endif |
0 commit comments