diff options
| author | Vladimir Byko-Ianko <v.bykoianko@corp.mail.ru> | 2016-09-12 12:51:10 +0300 |
|---|---|---|
| committer | Vladimir Byko-Ianko <v.bykoianko@corp.mail.ru> | 2016-09-13 11:25:06 +0300 |
| commit | ef3f36bcdecc1f86c4e3e7a5c0f4ee83ba54a9cb (patch) | |
| tree | fc668533038bda62d0ef249d4b2307a0ffa7e82e /map/framework.hpp | |
| parent | fc74d2edcb9d958133141404f038975ac1b930e9 (diff) | |
Review fixes.
Diffstat (limited to 'map/framework.hpp')
| -rw-r--r-- | map/framework.hpp | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/map/framework.hpp b/map/framework.hpp index 5e181f1b94..afdc5b4f45 100644 --- a/map/framework.hpp +++ b/map/framework.hpp @@ -729,7 +729,9 @@ public: /// false otherwise. bool HasRouteAltitude() const; /// \brief Generates 4 bytes per point image (RGBA) and put the data to |imageRGBAData|. - /// \returns If there is valid route info and returns true and false otherwise. + /// \returns If there is valid route info and the chart was generated returns true + /// and false otherwise. If the method returns true it is guaranteed that the size of + /// |imageRGBAData| is more than zero. /// \note If HasRouteAltitude() method returns true, GenerateRouteAltitudeChart(...) /// could return false if route was deleted or rebuilt between the calls. bool GenerateRouteAltitudeChart(uint32_t width, uint32_t height, |