diff options
author | mvglasow <michael -at- vonglasow.com> | 2019-08-10 18:05:13 +0200 |
---|---|---|
committer | mvglasow <michael -at- vonglasow.com> | 2019-08-10 18:05:13 +0200 |
commit | a4fec5342fb2f93db5265cee99ef7ef6e7913937 (patch) | |
tree | a368307229f885baf2a63f3b6c4f43cc8a87230f | |
parent | abaf43f392934d76368622db85f850123f355eb2 (diff) | |
download | navit-a4fec5342fb2f93db5265cee99ef7ef6e7913937.tar.gz |
Refactor:core:Improve documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com>
-rw-r--r-- | navit/mapset.c | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/navit/mapset.c b/navit/mapset.c index a2e914b6b..58751ee1e 100644 --- a/navit/mapset.c +++ b/navit/mapset.c @@ -179,11 +179,19 @@ mapset_open(struct mapset *ms) { /** * @brief Gets the next map from a mapset handle * - * If you set active to true, this function will not return any maps that - * have the attr_active attribute associated with them and set to false. + * The `active` argument governs whether (and how) to limit the search to active maps: + * + * Passing 0 causes this function to cycle through all maps, whether active or not. + * + * Passing a value of 2 will return only maps which have the `attr_route_active` attribute set to true. + * + * Passing a value of 3 will return only maps which have the `attr_search_active` attribute set to true. + * + * Passing any other nonzero value will return only maps which have the `attr_active` attribute set to true, + * or not set at all. * * @param msh The mapset handle to get the next map of - * @param active Set to true to only get active maps (See description) + * @param active Whether to cycle only through active maps (see description) * @return The next map */ struct map * mapset_next(struct mapset_handle *msh, int active) { |