[pgr_astarCost] Arrange comments

MarPetra · MarPetra · commit f5d7f1ba73a0 · 2018-11-26T12:56:13.000-06:00
diff --git a/sql/astar/astarCost.sql b/sql/astar/astarCost.sql
@@ -52,22 +52,6 @@ COST 100
 ROWS 1000;
 
 
-COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
-IS 'pgr_aStarCost(One to One)
- - Parameters:
-   - edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
-   - From vertex identifier
-   - To vertex identifier
- - Optional Parameters: 
-   - directed := true
-   - heuristic := 5
-   - factor := 1
-   - epsilon := 1
- - Documentation:
-   - ${PGROUTING_DOC_LINK}/pgr_astar.html
-';
-
-
 
 CREATE OR REPLACE FUNCTION pgr_aStarCost(
     TEXT,       -- edges sql (required)
@@ -93,21 +77,6 @@ COST 100
 ROWS 1000;
 
 
-COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
-IS 'pgr_astar(One to Many)
- - Parameters:
-   - edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
-   - From vertex identifier
-   - To ARRAY[vertices identifiers]
- - Optional Parameters: 
-   - directed := true
-   - heuristic := 5
-   - factor := 1
-   - epsilon := 1
- - Documentation:
-   - ${PGROUTING_DOC_LINK}/pgr_astar.html
-';
-
 
 CREATE OR REPLACE FUNCTION pgr_aStarCost(
     TEXT,       -- edges sql (required)
@@ -132,20 +101,6 @@ LANGUAGE sql VOLATILE STRICT
 COST 100
 ROWS 1000;
 
-COMMENT ON FUNCTION pgr_aStarCost(TEXT, ANYARRAY, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
-IS 'pgr_astar(Many to One)
- - Parameters:
-   - edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
-   - From ARRAY[vertices identifiers]
-   - To vertex identifier
- - Optional Parameters: 
-   - directed := true
-   - heuristic := 5
-   - factor := 1
-   - epsilon := 1
- - Documentation:
-   - ${PGROUTING_DOC_LINK}/pgr_astar.html
-';
 
 CREATE OR REPLACE FUNCTION pgr_aStarCost(
     TEXT,       -- edges sql (required)
@@ -172,11 +127,29 @@ COST 100
 ROWS 1000;
 
 
-   COMMENT ON FUNCTION pgr_aStarCost(TEXT, ANYARRAY, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
-IS 'pgr_astar(Many to Many)
+-- COMMENTS
+
+COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
+IS 'pgr_aStarCost(One to One)
  - Parameters:
    - edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
-   - From ARRAY[vertices identifiers]
+   - From vertex identifier
+   - To vertex identifier
+ - Optional Parameters: 
+   - directed := true
+   - heuristic := 5
+   - factor := 1
+   - epsilon := 1
+ - Documentation:
+   - ${PGROUTING_DOC_LINK}/pgr_astar.html
+';
+
+
+COMMENT ON FUNCTION pgr_aStarCost(TEXT, BIGINT, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
+IS 'pgr_astar(One to Many)
+ - Parameters:
+   - edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
+   - From vertex identifier
    - To ARRAY[vertices identifiers]
  - Optional Parameters: 
    - directed := true
@@ -188,6 +161,33 @@ IS 'pgr_astar(Many to Many)
 ';
 
 
+COMMENT ON FUNCTION pgr_aStarCost(TEXT, ANYARRAY, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
+IS 'pgr_astar(Many to One)
+ - Parameters:
+   - edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
+   - From ARRAY[vertices identifiers]
+   - To vertex identifier
+ - Optional Parameters: 
+   - directed := true
+   - heuristic := 5
+   - factor := 1
+   - epsilon := 1
+ - Documentation:
+   - ${PGROUTING_DOC_LINK}/pgr_astar.html
+';
 
 
--- COMMENTS
+COMMENT ON FUNCTION pgr_aStarCost(TEXT, ANYARRAY, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
+IS 'pgr_astar(Many to Many)
+ - Parameters:
+   - edges SQL with columns: id, source, target, cost [,reverse_cost], x1, y1, x2, y2
+   - From ARRAY[vertices identifiers]
+   - To ARRAY[vertices identifiers]
+ - Optional Parameters: 
+   - directed := true
+   - heuristic := 5
+   - factor := 1
+   - epsilon := 1
+ - Documentation:
+   - ${PGROUTING_DOC_LINK}/pgr_astar.html
+';
