diff options
| author | mvglasow <michael@vonglasow.com> | 2017-11-27 05:32:38 +0100 |
|---|---|---|
| committer | Pierre GRANDIN <pgrandin@users.noreply.github.com> | 2017-11-26 20:32:38 -0800 |
| commit | 25449bf52d1279f73fee0ea35775646ca499ae02 (patch) | |
| tree | 6a223da9dfdf7a476540051783ac241f1f3ac0b3 /navit/map.h | |
| parent | 7030908f604d268cf38baee920fe66e98da8ec72 (diff) | |
| download | navit-25449bf52d1279f73fee0ea35775646ca499ae02.tar.gz | |
Refine documentation (#378)
* Refactor:route:Improve documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com>
* Refactor:core:Refine documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com>
* Refactor:core:Improve documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com>
* Refactor:core:Improve documentatio
Signed-off-by: mvglasow <michael -at- vonglasow.com>
Diffstat (limited to 'navit/map.h')
| -rw-r--r-- | navit/map.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/navit/map.h b/navit/map.h index 305c26b96..4ffe0d401 100644 --- a/navit/map.h +++ b/navit/map.h @@ -79,13 +79,13 @@ struct map_methods { struct map_rect_priv * (*map_rect_new)(struct map_priv *map, struct map_selection *sel); /**< Function to create a new map rect on the map. */ void (*map_rect_destroy)(struct map_rect_priv *mr); /**< Function to destroy a map rect */ struct item * (*map_rect_get_item)(struct map_rect_priv *mr); /**< Function to return the next item from a map rect */ - struct item * (*map_rect_get_item_byid)(struct map_rect_priv *mr, int id_hi, int id_lo); /**< Function to get an item with a specific ID from a map rect */ - struct map_search_priv *(*map_search_new)(struct map_priv *map, struct item *item, struct attr *search, int partial); /**< Function to start a new search on the map */ - void (*map_search_destroy)(struct map_search_priv *ms); /**< Function to destroy a map search struct */ - struct item * (*map_search_get_item)(struct map_search_priv *ms); /**< Function to get the next item of a search on the map */ + struct item * (*map_rect_get_item_byid)(struct map_rect_priv *mr, int id_hi, int id_lo); /**< Function to get an item with a specific ID from a map rect, can be NULL */ + struct map_search_priv *(*map_search_new)(struct map_priv *map, struct item *item, struct attr *search, int partial); /**< Function to start a new search on the map, can be NULL */ + void (*map_search_destroy)(struct map_search_priv *ms); /**< Function to destroy a map search struct, ignored if `map_search_new` is NULL */ + struct item * (*map_search_get_item)(struct map_search_priv *ms); /**< Function to get the next item of a search on the map, ignored if `map_search_new` is NULL */ struct item * (*map_rect_create_item)(struct map_rect_priv *mr, enum item_type type); /**< Function to create a new item in the map */ - int (*map_get_attr)(struct map_priv *priv, enum attr_type type, struct attr *attr); - int (*map_set_attr)(struct map_priv *priv, struct attr *attr); + int (*map_get_attr)(struct map_priv *priv, enum attr_type type, struct attr *attr); /**< Function to get a map attribute, can be NULL */ + int (*map_set_attr)(struct map_priv *priv, struct attr *attr); /**< Function to set a map attribute, can be NULL */ }; |