diff options
| author | sleske <sleske@ffa7fe5e-494d-0410-b361-a75ebd5db220> | 2014-12-26 00:43:34 +0000 |
|---|---|---|
| committer | sleske <sleske@ffa7fe5e-494d-0410-b361-a75ebd5db220> | 2014-12-26 00:43:34 +0000 |
| commit | 2b6ce91d8f43f4766f2ba02b0f64183e035ede2a (patch) | |
| tree | d102e24c971577e08e81c52ca494ef41d69ded58 /navit | |
| parent | 72610e10606966e678dc402f5847e0cf86d16a38 (diff) | |
| download | navit-svn-2b6ce91d8f43f4766f2ba02b0f64183e035ede2a.tar.gz | |
Refactor:core:Improve Doxygen comments
git-svn-id: http://svn.code.sf.net/p/navit/code/trunk/navit@5984 ffa7fe5e-494d-0410-b361-a75ebd5db220
Diffstat (limited to 'navit')
| -rw-r--r-- | navit/navit.c | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/navit/navit.c b/navit/navit.c index aca3ef09..322c8cc2 100644 --- a/navit/navit.c +++ b/navit/navit.c @@ -80,11 +80,20 @@ #define TEXTFILE_COMMENT_NAVI_STOPPED "# navigation stopped\n" /** - * @defgroup navit the navit core instance. navit is the object containing nearly everything: A set of maps, one or more vehicle, a graphics object for rendering the map, a gui object for displaying the user interface, a route object, a navigation object and so on. Be warned that it is theoretically possible to have more than one navit object + * @defgroup navit The navit core instance + * @brief navit is the object containing most global data structures. + * + * Among others: + * - a set of maps + * - one or more vehicles + * - a graphics object for rendering the map + * - a gui object for displaying the user interface + * - a route object + * - a navigation object * @{ */ -//! The navit_vehicule +//! The vehicle used for navigation. struct navit_vehicle { int follow; /*! Limit of the follow counter. See navit_add_vehicle */ @@ -236,7 +245,7 @@ navit_get_user_data_directory(int create) { } } return dir; -} /* end: navit_get_user_data_directory(gboolean create) */ +} void |