Fabio/brouter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

updated doc entries

Browse source
This commit is contained in:
afischerdev 2023-09-30 11:13:57 +02:00
parent fe08674632
commit 3acb0b1fdb
1 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
brouter-core/src/main/java/btools/router/RoutingParamCollector.java
View file

@ -14,8 +14,9 @@ public class RoutingParamCollector {
/** /**
* get a list of points and optional extra info for the points * get a list of points and optional extra info for the points
* @param lonLats - linked list separated by ';' or '|' *
* @return - a list * @param lonLats linked list separated by ';' or '|'
* @return a list
*/ */
public List<OsmNodeNamed> getWayPointList(String lonLats) { public List<OsmNodeNamed> getWayPointList(String lonLats) {
if (lonLats == null) throw new IllegalArgumentException("lonlats parameter not set"); if (lonLats == null) throw new IllegalArgumentException("lonlats parameter not set");
@ -49,9 +50,10 @@ public class RoutingParamCollector {
/** /**
* get a list of points (old style, positions only) * get a list of points (old style, positions only)
* @param lons - array with longitudes *
* @param lats - array with latitudes * @param lons array with longitudes
* @return - a list * @param lats array with latitudes
* @return a list
*/ */
public List<OsmNodeNamed> readPositions(double[] lons, double[] lats) { public List<OsmNodeNamed> readPositions(double[] lons, double[] lats) {
List<OsmNodeNamed> wplist = new ArrayList<>(); List<OsmNodeNamed> wplist = new ArrayList<>();
@ -93,9 +95,10 @@ public class RoutingParamCollector {
/** /**
* read a url like parameter list linked with '&' * read a url like parameter list linked with '&'
* @param url - parameter list *
* @return - a hashmap of the parameter * @param url parameter list
* @throws UnsupportedEncodingException * @return a hashmap of the parameter
* @throws UnsupportedEncodingException
*/ */
public Map<String, String> getUrlParams(String url) throws UnsupportedEncodingException { public Map<String, String> getUrlParams(String url) throws UnsupportedEncodingException {
HashMap<String, String> params = new HashMap<>(); HashMap<String, String> params = new HashMap<>();
@ -117,9 +120,10 @@ public class RoutingParamCollector {
/** /**
* fill a parameter map into the routing context * fill a parameter map into the routing context
* @param rctx - the context *
* @param wplist - the list of way points needed for 'straight' parameter * @param rctx the context
* @param params - the list of parameters * @param wplist the list of way points needed for 'straight' parameter
* @param params the list of parameters
*/ */
public void setParams(RoutingContext rctx, List<OsmNodeNamed> wplist, Map<String, String> params) { public void setParams(RoutingContext rctx, List<OsmNodeNamed> wplist, Map<String, String> params) {
if (params != null) { if (params != null) {
@ -227,8 +231,9 @@ public class RoutingParamCollector {
/** /**
* fill profile parameter list * fill profile parameter list
* @param rctx - the routing context *
* @param params - the list of parameters * @param rctx the routing context
* @param params the list of parameters
*/ */
public void setProfileParams(RoutingContext rctx, Map<String, String> params) { public void setProfileParams(RoutingContext rctx, Map<String, String> params) {
if (params != null) { if (params != null) {