diff options
author | mvglasow <michael -at- vonglasow.com> | 2015-10-04 16:45:11 +0200 |
---|---|---|
committer | mvglasow <michael -at- vonglasow.com> | 2015-10-04 16:45:11 +0200 |
commit | 6cdd491979e751595f671f45cf1c16e910639e99 (patch) | |
tree | fe685e04b80a90a4439b92d901d9d4bf8a89f66e | |
parent | 7de2f45d1403c3f7b683ab0ec681beefd61fbfbb (diff) | |
download | navit-6cdd491979e751595f671f45cf1c16e910639e99.tar.gz |
Refactor:core:Improve documentation in navit.c and route.c
Signed-off-by: mvglasow <michael -at- vonglasow.com>
-rw-r--r-- | navit/navit.c | 3 | ||||
-rw-r--r-- | navit/route.c | 12 |
2 files changed, 10 insertions, 5 deletions
diff --git a/navit/navit.c b/navit/navit.c index 5420a08cc..79c4ba955 100644 --- a/navit/navit.c +++ b/navit/navit.c @@ -1535,7 +1535,8 @@ navit_mark_navigation_stopped(char *former_destination_file){ * @param navit The navit instance * @param c The coordinate to start routing to * @param description A label which allows the user to later identify this destination in the former destinations selection - * @returns nothing + * @param async Set to 1 to do route calculation asynchronously + * @return nothing */ void navit_set_destination(struct navit *this_, struct pcoord *c, const char *description, int async) diff --git a/navit/route.c b/navit/route.c index 271b5fa3e..7214b35d7 100644 --- a/navit/route.c +++ b/navit/route.c @@ -1123,8 +1123,8 @@ route_clear_destinations(struct route *this_) * * @param this The route to set the destination for * @param dst Coordinates to set as destination - * @param count: Number of destinations (last one is final) - * @param async: If set, do routing asynchronously + * @param count Number of destinations (last one is final) + * @param async If set, do routing asynchronously */ void @@ -1253,8 +1253,8 @@ route_get_destination_description(struct route *this, int n) * @brief Start a route given set of coordinates * * @param this The route instance - * @param c The coordinate to start routing to - * @param async 1 for async + * @param dst The coordinate to start routing to + * @param async Set to 1 to do route calculation asynchronously * @return nothing */ void @@ -2870,11 +2870,13 @@ route_graph_build_idle(struct route_graph *rg, struct vehicleprofile *profile) * between c1 and c2. * * @param ms The mapset to build the route graph from + * @param c The coordinates of the destination or next waypoint * @param c1 Corner 1 of the rectangle to use from the map * @param c2 Corner 2 of the rectangle to use from the map * @param done_cb The callback which will be called when graph is complete * @return The new route graph. */ +// FIXME documentation does not match argument list static struct route_graph * route_graph_build(struct mapset *ms, struct coord *c, int count, struct callback *done_cb, int async, struct vehicleprofile *profile) { @@ -2910,6 +2912,8 @@ route_graph_update_done(struct route *this, struct callback *cb) * adds routing information afterwards by calling route_graph_flood(). * * @param this The route to update the graph for + * @param cb The callback function to call when the route graph update is complete (used only in asynchronous mode) + * @param async Set to nonzero in order to update the route graph asynchronously */ static void route_graph_update(struct route *this, struct callback *cb, int async) |