summaryrefslogtreecommitdiff
path: root/navit/route_protected.h
diff options
context:
space:
mode:
authormvglasow <michael@vonglasow.com>2021-02-28 13:27:09 +0100
committerGitHub <noreply@github.com>2021-02-28 13:27:09 +0100
commit2146fcd9c9ce1560b725e481dc8b808dd425b1d2 (patch)
tree5a7b652cf17ae15208205a626d4daa58aeeb6c43 /navit/route_protected.h
parente90aa031b50b6d3031537b30fd9c559d43c516cf (diff)
downloadnavit-2146fcd9c9ce1560b725e481dc8b808dd425b1d2.tar.gz
Refactor:core:Documentation update (#1095)
Diffstat (limited to 'navit/route_protected.h')
-rw-r--r--navit/route_protected.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/navit/route_protected.h b/navit/route_protected.h
index 3ce6c4663..32d61e9bd 100644
--- a/navit/route_protected.h
+++ b/navit/route_protected.h
@@ -140,7 +140,9 @@ struct route_graph_segment {
* each segment.
*/
struct route_graph {
- int busy; /**< The graph is being built */
+ int busy; /**< Route calculation is in progress: the graph is being built,
+ * flooded or the path is being built (a more detailed status can be
+ * obtained from the route’s status attribute) */
struct map_selection *sel; /**< The rectangle selection for the graph */
struct mapset_handle *h; /**< Handle to the mapset */
struct map *m; /**< Pointer to the currently active map */
@@ -150,7 +152,7 @@ struct route_graph {
struct callback *done_cb; /**< Callback when graph is done */
struct event_idle *idle_ev; /**< The pointer to the idle event */
struct route_graph_segment *route_segments; /**< Pointer to the first route_graph_segment in the linked list of all segments */
- struct route_graph_segment *avoid_seg;
+ struct route_graph_segment *avoid_seg; /**< Segment to which a turnaround penalty (if active) applies */
struct fibheap *heap; /**< Priority queue for points to be expanded */
#define HASH_SIZE 8192
struct route_graph_point *hash[HASH_SIZE]; /**< A hashtable containing all route_graph_points in this graph */