[pgr_astarCost(One to Many)] Adding comment

MarPetra · MarPetra · commit 8943b81f05e8 · 2018-11-26T12:56:13.000-06:00
diff --git a/sql/astar/astarCost.sql b/sql/astar/astarCost.sql
@@ -93,6 +93,22 @@ COST 100
 ROWS 1000;
 
 
+COMMENT ON FUNCTION pgr_astar(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)
     ANYARRAY,   -- from_vids (required)
