diff options
author | Yuri Gorshenin <y@mmaps.me> | 2015-04-03 14:23:08 +0300 |
---|---|---|
committer | Alex Zolotarev <alex@maps.me> | 2015-09-23 02:41:36 +0300 |
commit | 7e21339eacb8154fee47c51baa60ee2c716f49e6 (patch) | |
tree | 9a6096a020218b8f690e429288345994013a5eeb /map/feature_vec_model.hpp | |
parent | 9e5ac4ef2a843481e59cbe5295c785a92a374bf9 (diff) |
Review fixes.
Diffstat (limited to 'map/feature_vec_model.hpp')
-rw-r--r-- | map/feature_vec_model.hpp | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/map/feature_vec_model.hpp b/map/feature_vec_model.hpp index e40830cb1a..c75528725f 100644 --- a/map/feature_vec_model.hpp +++ b/map/feature_vec_model.hpp @@ -32,18 +32,19 @@ namespace model public: void InitClassificator(); - /// Registers new map. + /// Registers a new map. /// - /// \return A pair of MwmLock and a flag. MwmLock is locked iff map - /// with fileName was created or already exists. Flag is - /// set when a new map was registered. Thus, there are - /// three main cases: - /// * map already exists - returns active lock and unset flag - /// * a new map was registered - returns active lock and set flag - /// * can't register new map - returns inactive lock and unset flag + /// \return A pair of an MwmLock and a flag. MwmLock is locked iff the + /// map with fileName was created or already exists. Flag + /// is set when the map was registered for a first + /// time. Thus, there are three main cases: + /// + /// * the map already exists - returns active lock and unset flag + /// * the map was already registered - returns active lock and set flag + /// * the map can't be registered - returns inactive lock and unset flag WARN_UNUSED_RESULT pair<MwmSet::MwmLock, bool> RegisterMap(string const & file); - /// Deregisters map denoted by file from internal records. + /// Deregisters a map denoted by file from internal records. void DeregisterMap(string const & file); /// Deregisters all registered maps. @@ -51,18 +52,18 @@ namespace model /// Deletes all files related to map denoted by file. /// - /// \return True if map was successfully deleted. + /// \return True if a map was successfully deleted. bool DeleteMap(string const & file); - /// Replaces map file corresponding to fileName with a new one, when + /// Replaces a map file corresponding to fileName with a new one, when /// it's possible - no clients of the map file. Otherwise, update /// will be delayed. /// - /// \return * map file have been updated - returns active lock and + /// \return * the map file have been updated - returns active lock and /// UPDATE_STATUS_OK - /// * update is delayed because map is busy - returns active lock and + /// * update is delayed because the map is busy - returns active lock and /// UPDATE_STATUS_UPDATE_DELAYED - /// * file isn't suitable for update - returns inactive lock and + /// * the file isn't suitable for update - returns inactive lock and /// UPDATE_STATUS_BAD_FILE WARN_UNUSED_RESULT pair<MwmSet::MwmLock, Index::UpdateStatus> UpdateMap(string const & file); //@} |