Skip to content

Commit c1baed4

Browse files
cvvergaracvvergara
committed
adding/fixing comments to functions starting with w
1 parent 0618764 commit c1baed4

6 files changed

Lines changed: 19 additions & 3 deletions

File tree

‎sql/common/pgrouting_version.sql‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,9 @@ $BODY$
3232
'${Boost_MAJOR_VERSION}.${Boost_MINOR_VERSION}.${Boost_SUBMINOR_VERSION}'::varchar AS boost;
3333
$BODY$
3434
LANGUAGE sql IMMUTABLE;
35+
36+
COMMENT ON FUNCTION pgr_version() IS
37+
'pgr_version
38+
- Documentation
39+
- ${PGROUTING_DOC_LINK}/pgr_version.html
40+
';

‎sql/driving_distance/withPointsDD.sql‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ IS 'pgRouting internal function';
116116

117117
COMMENT ON FUNCTION pgr_withPointsDD(TEXT, TEXT, BIGINT, FLOAT, BOOLEAN, CHAR, BOOLEAN)
118118
IS 'pgr_withPointsDD(Single Vertex)
119+
- PROPOSED
119120
- Parameters:
120121
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
121122
- Points SQL with colums: [pid], edge_id, fraction[,side]
@@ -132,6 +133,7 @@ IS 'pgr_withPointsDD(Single Vertex)
132133

133134
COMMENT ON FUNCTION pgr_withPointsDD(TEXT, TEXT, ANYARRAY, FLOAT, BOOLEAN, CHAR, BOOLEAN, BOOLEAN)
134135
IS 'pgr_withPointsDD(Multiple Vertices)
136+
- PROPOSED
135137
- Parameters:
136138
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
137139
- Points SQL with colums: [pid], edge_id, fraction[,side]
@@ -144,4 +146,4 @@ IS 'pgr_withPointsDD(Multiple Vertices)
144146
- equicost := false
145147
- Documentation:
146148
- ${PGROUTING_DOC_LINK}/pgr_withPointsDD.html
147-
';
149+
';

‎sql/ksp/withPointsKSP.sql‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ IS 'pgRouting internal function';
7676

7777
COMMENT ON FUNCTION pgr_withPointsKSP(TEXT, TEXT, BIGINT, BIGINT, INTEGER, BOOLEAN, BOOLEAN, CHAR, BOOLEAN)
7878
IS 'pgr_withPointsKSP
79+
- PROPOSED
7980
- Parameters:
8081
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
8182
- Points SQL with colums: [pid], edge_id, fraction[,side]

‎sql/vrp_basic/pgr_vrpOneDepot.sql‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,5 @@ IS 'pgr_vrpOneDepot
6868
- cost SQL with columns: src_id, dest_id, cost, distance, traveltime
6969
- depot id
7070
- Documentation:
71-
- ${PGROUTING_DOC_LINK}/pgr_trsp.html
71+
- ${PGROUTING_DOC_LINK}/pgr_vrpOneDepot.html
7272
';

‎sql/withPoints/withPoints.sql‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ ROWS 1000;
150150

151151
COMMENT ON FUNCTION pgr_withPoints(TEXT, TEXT, BIGINT, BIGINT, BOOLEAN, CHAR, BOOLEAN)
152152
IS 'pgr_withPoints (One to One)
153+
- PROPOSED
153154
- Parameters:
154155
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
155156
- Points SQL with columns: [pid], edge_id, fraction[,side]
@@ -166,6 +167,7 @@ IS 'pgr_withPoints (One to One)
166167

167168
COMMENT ON FUNCTION pgr_withPoints(TEXT, TEXT, BIGINT, ANYARRAY, BOOLEAN, CHAR, BOOLEAN)
168169
IS 'pgr_withPoints (One to Many)
170+
- PROPOSED
169171
- Parameters:
170172
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
171173
- Points SQL with columns: [pid], edge_id, fraction[,side]
@@ -182,6 +184,7 @@ IS 'pgr_withPoints (One to Many)
182184

183185
COMMENT ON FUNCTION pgr_withPoints(TEXT, TEXT, ANYARRAY, BIGINT, BOOLEAN, CHAR, BOOLEAN)
184186
IS 'pgr_withPoints (Many to One)
187+
- PROPOSED
185188
- Parameters:
186189
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
187190
- Points SQL with columns: [pid], edge_id, fraction[,side]
@@ -198,6 +201,7 @@ IS 'pgr_withPoints (Many to One)
198201

199202
COMMENT ON FUNCTION pgr_withPoints(TEXT, TEXT, ANYARRAY, ANYARRAY, BOOLEAN, CHAR, BOOLEAN)
200203
IS 'pgr_withPoints (Many to Many)
204+
- PROPOSED
201205
- Parameters:
202206
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
203207
- Points SQL with columns: [pid], edge_id, fraction[,side]
@@ -209,4 +213,4 @@ IS 'pgr_withPoints (Many to Many)
209213
- details := ''false''
210214
- Documentation:
211215
- ${PGROUTING_DOC_LINK}/pgr_withPoints.html
212-
';
216+
';

‎sql/withPoints/withPointsCost.sql‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ ROWS 1000;
130130

131131
COMMENT ON FUNCTION pgr_withPointsCost(TEXT, TEXT, BIGINT, BIGINT, BOOLEAN, CHAR)
132132
IS 'pgr_withPointsCost (One to One)
133+
- PROPOSED
133134
- Parameters:
134135
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
135136
- Points SQL with columns: [pid], edge_id, fraction[,side]
@@ -145,6 +146,7 @@ IS 'pgr_withPointsCost (One to One)
145146

146147
COMMENT ON FUNCTION pgr_withPointsCost(TEXT, TEXT, BIGINT, ANYARRAY, BOOLEAN, CHAR)
147148
IS 'pgr_withPointsCost (One to Many)
149+
- PROPOSED
148150
- Parameters:
149151
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
150152
- Points SQL with columns: [pid], edge_id, fraction[,side]
@@ -160,6 +162,7 @@ IS 'pgr_withPointsCost (One to Many)
160162

161163
COMMENT ON FUNCTION pgr_withPointsCost(TEXT, TEXT, ANYARRAY, BIGINT, BOOLEAN, CHAR)
162164
IS 'pgr_withPointsCost (Many to One)
165+
- PROPOSED
163166
- Parameters:
164167
- Edges SQL with columns: id, source, target, cost [,reverse_cost]
165168
- Points SQL with columns: [pid], edge_id, fraction[,side]

0 commit comments

Comments
 (0)