Skip to content

Commit 6e317d1

Browse files
cvvergaracvvergara
committed
adding comments to internal functions
1 parent 1e0e7ac commit 6e317d1

7 files changed

Lines changed: 56 additions & 2 deletions

File tree

‎sql/common/_point_toId.sql‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,6 @@ END;
7979
$BODY$
8080
LANGUAGE plpgsql VOLATILE STRICT;
8181

82+
COMMENT ON FUNCTION _pgr_pointToId(geometry, FLOAT, TEXT, INTEGER)
83+
IS 'pgRouting internal function';
84+

‎sql/common/createIndex.sql‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,8 @@ $BODY$
113113
LANGUAGE plpgsql VOLATILE STRICT;
114114

115115

116+
COMMENT ON FUNCTION _pgr_createIndex(TEXT, TEXT, TEXT, TEXT, INTEGER, TEXT)
117+
IS 'pgRouting internal function';
118+
119+
COMMENT ON FUNCTION _pgr_createIndex(TEXT, TEXT, TEXT, INTEGER, TEXT)
120+
IS 'pgRouting internal function';

‎sql/common/pgr_parameter_check.sql‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,6 @@ CREATE OR REPLACE FUNCTION _pgr_parameter_check(fn text, sql text, big boolean d
161161
LANGUAGE plpgsql VOLATILE
162162
COST 1;
163163

164+
COMMENT ON FUNCTION _pgr_parameter_check(TEXT, TEXT, BOOLEAN)
165+
IS 'pgRouting internal function';
164166

‎sql/common/pgrouting_utilities.sql‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,10 @@ END;
129129
$$
130130
LANGUAGE plpgsql VOLATILE STRICT;
131131

132+
COMMENT ON FUNCTION _pgr_getTableName(TEXT, INTEGER, TEXT)
133+
IS 'pgRouting internal function';
134+
135+
132136

133137

134138
/*
@@ -202,6 +206,10 @@ END;
202206
$BODY$
203207
LANGUAGE plpgsql VOLATILE STRICT;
204208

209+
COMMENT ON FUNCTION _pgr_getColumnName(TEXT, TEXT, TEXT, INTEGER, TEXT)
210+
IS 'pgRouting internal function';
211+
COMMENT ON FUNCTION _pgr_getColumnName(TEXT, TEXT, INTEGER, TEXT)
212+
IS 'pgRouting internal function';
205213

206214
/*
207215
.. function:: _pgr_isColumnInTable(tab, col)
@@ -233,6 +241,8 @@ END;
233241
$BODY$
234242
LANGUAGE plpgsql VOLATILE STRICT;
235243

244+
COMMENT ON FUNCTION _pgr_isColumnInTable(TEXT, TEXT)
245+
IS 'pgRouting internal function';
236246

237247
/*
238248
.. function:: _pgr_isColumnIndexed(tab, col)
@@ -342,6 +352,10 @@ END
342352
$BODY$
343353
LANGUAGE plpgsql VOLATILE STRICT;
344354

355+
COMMENT ON FUNCTION _pgr_isColumnIndexed(TEXT, TEXT, TEXT, INTEGER, TEXT)
356+
IS 'pgRouting internal function';
357+
COMMENT ON FUNCTION _pgr_isColumnIndexed(TEXT, TEXT, INTEGER, TEXT)
358+
IS 'pgRouting internal function';
345359
/*
346360
.. function:: _pgr_quote_ident(text)
347361
@@ -378,6 +392,9 @@ end;
378392
$body$
379393
language plpgsql immutable;
380394

395+
COMMENT ON FUNCTION _pgr_quote_ident(TEXT)
396+
IS 'pgRouting internal function';
397+
381398
/*
382399
* function for comparing version strings.
383400
* Ex: select _pgr_version_less(postgis_lib_version(), '2.1');
@@ -437,6 +454,9 @@ $BODY$
437454
LANGUAGE plpgsql VOLATILE
438455
COST 1;
439456

457+
COMMENT ON FUNCTION _pgr_versionless(TEXT, TEXT)
458+
IS 'pgRouting internal function';
459+
440460
create or replace function _pgr_startPoint(g geometry)
441461
returns geometry as
442462
$body$
@@ -452,6 +472,8 @@ end;
452472
$body$
453473
language plpgsql IMMUTABLE;
454474

475+
COMMENT ON FUNCTION _pgr_startPoint(geometry)
476+
IS 'pgRouting internal function';
455477

456478

457479
create or replace function _pgr_endPoint(g geometry)
@@ -469,3 +491,5 @@ end;
469491
$body$
470492
language plpgsql IMMUTABLE;
471493

494+
COMMENT ON FUNCTION _pgr_endPoint(geometry)
495+
IS 'pgRouting internal function';

‎sql/common/utilities_pgr.sql‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ END;
7878
$BODY$
7979
LANGUAGE plpgsql VOLATILE STRICT;
8080

81+
COMMENT ON FUNCTION _pgr_onError(BOOLEAN, INTEGER, TEXT, TEXT, TEXT, TEXT)
82+
IS 'pgRouting internal function';
83+
84+
8185
/************************************************************************
8286
.. function:: _pgr_msg(msgKind, fnName, msg)
8387
@@ -112,6 +116,8 @@ END;
112116
$BODY$
113117
LANGUAGE plpgsql VOLATILE STRICT;
114118

119+
COMMENT ON FUNCTION _pgr_msg(INTEGER, TEXT, TEXT)
120+
IS 'pgRouting internal function';
115121

116122
/************************************************************************
117123
.. function:: _pgr_getColumnType(sname,tname,col,reportErrs,fnName) returns text
@@ -186,6 +192,11 @@ $BODY$
186192
LANGUAGE plpgsql VOLATILE STRICT;
187193

188194

195+
COMMENT ON FUNCTION _pgr_getColumnType(TEXT, TEXT, TEXT, INTEGER, TEXT)
196+
IS 'pgRouting internal function';
197+
198+
COMMENT ON FUNCTION _pgr_getColumnType(TEXT, TEXT, INTEGER, TEXT)
199+
IS 'pgRouting internal function';
189200

190201

191202

@@ -220,6 +231,8 @@ END
220231
$BODY$
221232
LANGUAGE plpgsql STABLE STRICT;
222233

234+
COMMENT ON FUNCTION _pgr_get_statement(TEXT)
235+
IS 'pgRouting internal function';
223236

224237
/************************************************************************
225238
.. function:: _pgr_checkVertTab(vertname,columnsArr,reportErrs) returns record of sname,vname
@@ -286,3 +299,6 @@ BEGIN
286299
$BODY$
287300
LANGUAGE plpgsql VOLATILE STRICT;
288301

302+
COMMENT ON FUNCTION _pgr_checkVertTab(TEXT, TEXT[], INTEGER, TEXT)
303+
IS 'pgRouting internal function';
304+

‎sql/dijkstra/_dijkstra.sql‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2626

2727
---------------
2828
---------------
29-
-- dijkstra
29+
-- dijkstra
3030
---------------
3131
---------------
3232

@@ -54,4 +54,4 @@ LANGUAGE C VOLATILE STRICT;
5454
-- COMMENTS
5555

5656
COMMENT ON FUNCTION _pgr_dijkstra(TEXT, ANYARRAY, ANYARRAY, BOOLEAN, BOOLEAN, BOOLEAN, BIGINT)
57-
IS 'pgRouting internal function';
57+
IS 'pgRouting internal function';

‎sql/driving_distance/drivingDistance.sql‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ RETURNS SETOF RECORD AS
4141
'MODULE_PATHNAME', 'driving_many_to_dist'
4242
LANGUAGE c VOLATILE STRICT;
4343

44+
COMMENT ON FUNCTION _pgr_drivingDistance(TEXT, ANYARRAY, FLOAT, BOOLEAN, BOOLEAN)
45+
IS 'pgRouting internal function';
46+
47+
4448
-- MULTIPLE
4549
CREATE OR REPLACE FUNCTION pgr_drivingDistance(
4650
TEXT, -- edges_sql (required)

0 commit comments

Comments
 (0)