diff options
| author | Sebastian Leske <sebastian.leske@sleske.name> | 2016-01-12 08:29:00 +0100 |
|---|---|---|
| committer | Sebastian Leske <sebastian.leske@sleske.name> | 2016-01-21 23:08:56 +0100 |
| commit | 41ea9f0d7e752facaac046977387ad35547e2cb7 (patch) | |
| tree | c9c94eae10f88ce2a60c4275778453d60363fd80 | |
| parent | 6585dd2d01f7458e90aec7ee4dd19f82a95f8b4e (diff) | |
| download | navit-41ea9f0d7e752facaac046977387ad35547e2cb7.tar.gz | |
Refactor:core:Fix Doxygen comments; @code only for code blocks.
| -rw-r--r-- | navit/navigation.c | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/navit/navigation.c b/navit/navigation.c index ba9b5aaeb..849bc7630 100644 --- a/navit/navigation.c +++ b/navit/navigation.c @@ -46,6 +46,10 @@ /* #define DEBUG */ +/** @file + * + * Generates navigation messages for a calculated route. + */ static int roundabout_extra_length=50; /* TODO: find out if this is being used elsewhere and, if so, move this definition somewhere more generic */ @@ -86,7 +90,7 @@ static int turn_2_limit = 45; static int sharp_turn_limit = 110; /** Minimum absolute delta for a U turn. - * Maneuvers whose absolute delta is less than this (but at least {@code min_turn_limit}) will always be announced as turns. + * Maneuvers whose absolute delta is less than this (but at least #min_turn_limit) will always be announced as turns. * Note that, depending on other conditions, even maneuvers whose delta exceeds the threshold may still be announced as (sharp) turns. */ static int u_turn_limit = 165; @@ -204,14 +208,14 @@ int distances[]={1,2,3,4,5,10,25,50,75,100,150,200,250,300,400,500,750,-1}; /** Merging into a motorway-like road, direction undefined. * This value is not intended to be set directly but can be used for - * comparisons, e.g. {@code merge_or_exit & mex_merge}. */ + * comparisons, e.g. `merge_or_exit & mex_merge`. */ #define mex_merge 1 /** Exiting from a motorway-like road, direction undefined. * This should only be used for ramps leading to a non-motorway road. - * For interchanges, use {@code mex_interchange} instead. + * For interchanges, use #mex_interchange instead. * This value is not intended to be set directly but can be used for - * comparisons, e.g. {@code merge_or_exit & mex_exit}. */ + * comparisons, e.g. `merge_or_exit & mex_merge`. */ #define mex_exit 2 /** Motorway-like road splits in two. @@ -222,14 +226,14 @@ int distances[]={1,2,3,4,5,10,25,50,75,100,150,200,250,300,400,500,750,-1}; #define mex_merge_right 9 /** Exiting from a motorway-like road to the right. - * See {@code mex_exit} for usage. */ + * @see mex_exit for usage */ #define mex_exit_right 10 /** Merging into a motorway-like road to the left (coming from the right) */ #define mex_merge_left 17 /** Exiting from a motorway-like road to the left. - * See {@code mex_exit} for usage. */ + * @see mex_exit for usage */ #define mex_exit_left 18 /** |