diff options
author | mvglasow <michael -at- vonglasow.com> | 2017-10-28 01:45:02 +0300 |
---|---|---|
committer | mvglasow <michael -at- vonglasow.com> | 2017-10-28 01:45:02 +0300 |
commit | 1f3675da69177429d9fad1cb77dcb8b7bc068e01 (patch) | |
tree | 4ca26ce1c1baccbfbaf58852eaa18b69aeede59a /navit/route.c | |
parent | fd6226ed544241ed2a4aab23e4a0103857a2d2f9 (diff) | |
download | navit-1f3675da69177429d9fad1cb77dcb8b7bc068e01.tar.gz |
Refactor:route:Add documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com>
Diffstat (limited to 'navit/route.c')
-rw-r--r-- | navit/route.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/navit/route.c b/navit/route.c index 294f17d5b..1eef9107c 100644 --- a/navit/route.c +++ b/navit/route.c @@ -217,7 +217,8 @@ struct route_info { /** * @brief A complete route path * - * This structure describes a whole routing path + * A route path is an ordered set of segments describing the route from the current position (or previous + * destination) to the next destination. */ struct route_path { int in_use; /**< The path is in use and can not be updated */ @@ -265,7 +266,8 @@ struct route { /** * @brief A complete route graph * - * This structure describes a whole routing graph + * The route graph holds all routable segments along with the connections between them and the cost of + * each segment. */ struct route_graph { int busy; /**< The graph is being built */ |