[pgr_astar(One to One)] Adding comment

MarPetra · MarPetra · commit bb50b88dd5d7 · 2018-11-26T12:56:13.000-06:00
diff --git a/sql/astar/astar.sql b/sql/astar/astar.sql
@@ -53,6 +53,32 @@ LANGUAGE sql VOLATILE STRICT
 COST 100
 ROWS 1000;
 
+COMMENT ON FUNCTION pgr_aStar(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
+IS 'pgr_aStar--One to One--(edges_sql(id,source,target,cost[,reverse_cost],x1,y1,x2,y2), from_vid, to_vid [,directed ,heuristic, factor ,epsilon])';
+
+
+COMMENT ON FUNCTION pgr_astar(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
+IS 'pgr_astar(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_astar(
     TEXT,       -- edges sql (required)
     BIGINT,     -- from_vid (required)
@@ -140,6 +166,10 @@ ROWS 1000;
 
 COMMENT ON FUNCTION pgr_aStar(TEXT, BIGINT, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
 IS 'pgr_aStar--One to One--(edges_sql(id,source,target,cost[,reverse_cost],x1,y1,x2,y2), from_vid, to_vid [,directed ,heuristic, factor ,epsilon])';
+
+
+
+
 COMMENT ON FUNCTION pgr_aStar(TEXT, BIGINT, ANYARRAY, BOOLEAN, INTEGER, FLOAT, FLOAT)
 IS 'pgr_aStar--One to Many--(edges_sql(id,source,target,cost[,reverse_cost],x1,y1,x2,y2), from_vid, to_vids [,directed, heuristic, factor, epsilon])';
 COMMENT ON FUNCTION pgr_aStar(TEXT, ANYARRAY, BIGINT, BOOLEAN, INTEGER, FLOAT, FLOAT)
