diff options
| author | mvglasow <michael@vonglasow.com> | 2018-01-11 06:52:29 +0100 |
|---|---|---|
| committer | jkoan <jkoan@users.noreply.github.com> | 2018-01-11 06:52:29 +0100 |
| commit | dd0f195da55c8011e4308cbe86fe24ea97412f71 (patch) | |
| tree | 604917000cec5c8021515a8c6817dfee2f27f62e /navit/map.h | |
| parent | 7f55725b43800e3ae7ce48e998350778f7517c6f (diff) | |
| download | navit-dd0f195da55c8011e4308cbe86fe24ea97412f71.tar.gz | |
Refactor:core:Add more documentation (#392)
Signed-off-by: mvglasow <michael -at- vonglasow.com>
Diffstat (limited to 'navit/map.h')
| -rw-r--r-- | navit/map.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/navit/map.h b/navit/map.h index 4ffe0d401..64261abc1 100644 --- a/navit/map.h +++ b/navit/map.h @@ -65,12 +65,16 @@ struct map_selection { }; /** - * @brief Holds all functions a map plugin has to implement to be useable + * @brief Holds all functions a map plugin has to implement to be usable * - * This structure holds pointers to a map plugin's functions navit's core will call - * to communicate with the plugin. For further information look into map.c - there exist + * This structure holds pointers to a map plugin's functions, which Navit's core will call + * to communicate with the plugin. For further information look into map.c, which has * functions with the same names acting more or less as "wrappers" around the functions here. * Especially the arguments (and their meaning) of each function will be described there. + * + * Note that there is no separate method to remove an item from a map. This is instead accomplished by + * retrieving the item, then setting its type to `type_none` via its `item_type_set` method (provided + * the item and its map support removal). */ struct map_methods { enum projection pro; /**< The projection used for that type of map */ |
