Skip to content

Commit 7482162

Browse files
cvvergaracvvergara
committed
adding/fixing comments to functions starting with a
1 parent 9c66cf1 commit 7482162

3 files changed

Lines changed: 38 additions & 38 deletions

File tree

‎sql/alpha_shape/alphaShape.sql‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,5 +88,5 @@ IS 'pgr_alphaShape
8888
- Optional Parameters
8989
- alpha := 0
9090
- Documentation:
91-
- ${PGROUTING_DOC_LINK}/pgr_alphashape.html
91+
- ${PGROUTING_DOC_LINK}/pgr_alphaShape.html
9292
';

‎sql/astar/astar.sql‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2828
********************************************************************PGR-GNU*/
2929

3030
-----------------
31-
-- pgr_astar
31+
-- pgr_aStar
3232
-----------------
3333

3434

35-
CREATE OR REPLACE FUNCTION pgr_astar(
35+
CREATE OR REPLACE FUNCTION pgr_aStar(
3636
TEXT, -- edges sql (required)
3737
BIGINT, -- from_vid (required)
3838
BIGINT, -- to_vid (required)
@@ -52,14 +52,14 @@ CREATE OR REPLACE FUNCTION pgr_astar(
5252
RETURNS SETOF RECORD AS
5353
$BODY$
5454
SELECT a.seq, a.path_seq, a.node, a.edge, a.cost, a.agg_cost
55-
FROM _pgr_astar(_pgr_get_statement($1), ARRAY[$2]::BIGINT[], ARRAY[$3]::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT) AS a;
55+
FROM _pgr_aStar(_pgr_get_statement($1), ARRAY[$2]::BIGINT[], ARRAY[$3]::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT) AS a;
5656
$BODY$
5757
LANGUAGE sql VOLATILE STRICT
5858
COST 100
5959
ROWS 1000;
6060

6161

62-
CREATE OR REPLACE FUNCTION pgr_astar(
62+
CREATE OR REPLACE FUNCTION pgr_aStar(
6363
TEXT, -- edges sql (required)
6464
BIGINT, -- from_vid (required)
6565
ANYARRAY, -- to_vids (required)
@@ -80,14 +80,14 @@ CREATE OR REPLACE FUNCTION pgr_astar(
8080
RETURNS SETOF RECORD AS
8181
$BODY$
8282
SELECT a.seq, a.path_seq, a.end_vid, a.node, a.edge, a.cost, a.agg_cost
83-
FROM _pgr_astar(_pgr_get_statement($1), ARRAY[$2]::BIGINT[], $3::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT) AS a;
83+
FROM _pgr_aStar(_pgr_get_statement($1), ARRAY[$2]::BIGINT[], $3::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT) AS a;
8484
$BODY$
8585
LANGUAGE sql VOLATILE STRICT
8686
COST 100
8787
ROWS 1000;
8888

8989

90-
CREATE OR REPLACE FUNCTION pgr_astar(
90+
CREATE OR REPLACE FUNCTION pgr_aStar(
9191
TEXT, -- edges sql (required)
9292
ANYARRAY, -- from_vids (required)
9393
BIGINT, -- to_vid (required)
@@ -108,14 +108,14 @@ CREATE OR REPLACE FUNCTION pgr_astar(
108108
RETURNS SETOF RECORD AS
109109
$BODY$
110110
SELECT a.seq, a.path_seq, a.start_vid, a.node, a.edge, a.cost, a.agg_cost
111-
FROM _pgr_astar(_pgr_get_statement($1), $2::BIGINT[], ARRAY[$3]::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT, normal:=false) AS a;
111+
FROM _pgr_aStar(_pgr_get_statement($1), $2::BIGINT[], ARRAY[$3]::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT, normal:=false) AS a;
112112
$BODY$
113113
LANGUAGE sql VOLATILE STRICT
114114
COST 100
115115
ROWS 1000;
116116

117117

118-
CREATE OR REPLACE FUNCTION pgr_astar(
118+
CREATE OR REPLACE FUNCTION pgr_aStar(
119119
TEXT, -- edges sql (required)
120120
ANYARRAY, -- from_vids (required)
121121
ANYARRAY, -- to_vids (required)
@@ -137,7 +137,7 @@ CREATE OR REPLACE FUNCTION pgr_astar(
137137
RETURNS SETOF RECORD AS
138138
$BODY$
139139
SELECT *
140-
FROM _pgr_astar(_pgr_get_statement($1), $2::BIGINT[], $3::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT) AS a;
140+
FROM _pgr_aStar(_pgr_get_statement($1), $2::BIGINT[], $3::BIGINT[], $4, $5, $6::FLOAT, $7::FLOAT) AS a;
141141
$BODY$
142142
LANGUAGE sql VOLATILE STRICT
143143
COST 100
@@ -147,65 +147,65 @@ ROWS 1000;
147147
-- COMMENTS
148148

149149

150-
COMMENT ON FUNCTION pgr_astar(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
151-
IS 'pgr_astar(One to One)
150+
COMMENT ON FUNCTION pgr_aStar(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
151+
IS 'pgr_aStar(One to One)
152152
- Parameters:
153153
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
154154
- From vertex identifier
155155
- To vertex identifier
156-
- Optional Parameters:
156+
- Optional Parameters:
157157
- directed := true
158158
- heuristic := 5
159159
- factor := 1
160160
- epsilon := 1
161161
- Documentation:
162-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
162+
- ${PGROUTING_DOC_LINK}/pgr_aStar.html
163163
';
164164

165165

166-
COMMENT ON FUNCTION pgr_astar(TEXT, BIGINT, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
167-
IS 'pgr_astar(One to Many)
166+
COMMENT ON FUNCTION pgr_aStar(TEXT, BIGINT, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
167+
IS 'pgr_aStar(One to Many)
168168
- Parameters:
169169
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
170170
- From vertex identifier
171171
- To ARRAY[vertices identifiers]
172-
- Optional Parameters:
172+
- Optional Parameters:
173173
- directed := true
174174
- heuristic := 5
175175
- factor := 1
176176
- epsilon := 1
177177
- Documentation:
178-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
178+
- ${PGROUTING_DOC_LINK}/pgr_aStar.html
179179
';
180180

181181

182-
COMMENT ON FUNCTION pgr_astar(TEXT, ANYARRAY, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
183-
IS 'pgr_astar(Many to One)
182+
COMMENT ON FUNCTION pgr_aStar(TEXT, ANYARRAY, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
183+
IS 'pgr_aStar(Many to One)
184184
- Parameters:
185185
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
186186
- From ARRAY[vertices identifiers]
187187
- To vertex identifier
188-
- Optional Parameters:
188+
- Optional Parameters:
189189
- directed := true
190190
- heuristic := 5
191191
- factor := 1
192192
- epsilon := 1
193193
- Documentation:
194-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
194+
- ${PGROUTING_DOC_LINK}/pgr_aStar.html
195195
';
196196

197197

198-
COMMENT ON FUNCTION pgr_astar(TEXT, ANYARRAY, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
199-
IS 'pgr_astar(Many to Many)
198+
COMMENT ON FUNCTION pgr_aStar(TEXT, ANYARRAY, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
199+
IS 'pgr_aStar(Many to Many)
200200
- Parameters:
201201
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
202202
- From ARRAY[vertices identifiers]
203203
- To ARRAY[vertices identifiers]
204-
- Optional Parameters:
204+
- Optional Parameters:
205205
- directed := true
206206
- heuristic := 5
207207
- factor := 1
208208
- epsilon := 1
209209
- Documentation:
210-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
211-
';
210+
- ${PGROUTING_DOC_LINK}/pgr_aStar.html
211+
';

‎sql/astar/astarCost.sql‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -141,59 +141,59 @@ IS 'pgr_aStarCost(One to One)
141141
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
142142
- From vertex identifier
143143
- To vertex identifier
144-
- Optional Parameters:
144+
- Optional Parameters:
145145
- directed := true
146146
- heuristic := 5
147147
- factor := 1
148148
- epsilon := 1
149149
- Documentation:
150-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
150+
- ${PGROUTING_DOC_LINK}/pgr_aStarCost.html
151151
';
152152

153153

154154
COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
155-
IS 'pgr_astar(One to Many)
155+
IS 'pgr_aStarCost(One to Many)
156156
- Parameters:
157157
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
158158
- From vertex identifier
159159
- To ARRAY[vertices identifiers]
160-
- Optional Parameters:
160+
- Optional Parameters:
161161
- directed := true
162162
- heuristic := 5
163163
- factor := 1
164164
- epsilon := 1
165165
- Documentation:
166-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
166+
- ${PGROUTING_DOC_LINK}/pgr_aStarCost.html
167167
';
168168

169169

170170
COMMENT ON FUNCTION pgr_aStarCost(TEXT, ANYARRAY, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
171-
IS 'pgr_astar(Many to One)
171+
IS 'pgr_aStarCost(Many to One)
172172
- Parameters:
173173
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
174174
- From ARRAY[vertices identifiers]
175175
- To vertex identifier
176-
- Optional Parameters:
176+
- Optional Parameters:
177177
- directed := true
178178
- heuristic := 5
179179
- factor := 1
180180
- epsilon := 1
181181
- Documentation:
182-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
182+
- ${PGROUTING_DOC_LINK}/pgr_aStarCost.html
183183
';
184184

185185

186186
COMMENT ON FUNCTION pgr_aStarCost(TEXT, ANYARRAY, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
187-
IS 'pgr_astar(Many to Many)
187+
IS 'pgr_aStarCost(Many to Many)
188188
- Parameters:
189189
- edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
190190
- From ARRAY[vertices identifiers]
191191
- To ARRAY[vertices identifiers]
192-
- Optional Parameters:
192+
- Optional Parameters:
193193
- directed := true
194194
- heuristic := 5
195195
- factor := 1
196196
- epsilon := 1
197197
- Documentation:
198-
- ${PGROUTING_DOC_LINK}/pgr_astar.html
198+
- ${PGROUTING_DOC_LINK}/pgr_aStarCost.html
199199
';

0 commit comments

Comments
 (0)