Corrections after colleagues comments.

1 files changed, 6 insertions, 0 deletions

diff --git a/map/framework.hpp b/map/framework.hpp
index e83347752e..b47313b30f 100644
--- a/map/framework.hpp
+++ b/map/framework.hpp
@@ -585,6 +585,12 @@ public:
   inline bool AreTurnNotificationsEnabled() const { return m_routingSession.AreTurnNotificationsEnabled(); }
   inline void SetTurnNotificationsLocale(string const & locale) { m_routingSession.SetTurnNotificationsLocale(locale); }
   inline string GetTurnNotificationsLocale() const { return m_routingSession.GetTurnNotificationsLocale(); }
+  /// \brief When an end user is going to a turn he gets sound turn instructions.
+  /// If C++ part wants the client to pronounce an instruction GenerateTurnSound (in turnNotifications) returns
+  /// an array of one of more strings. C++ part assumes that all these strings shall be pronounced by the client's TTS.
+  /// For example if C++ part wants the client to pronounce "Make a right turn." this method returns
+  /// an array with one string "Make a right turn.". The next call of the method returns nothing.
+  /// GenerateTurnSound shall be called by the client when a new position is available.
   inline void GenerateTurnSound(vector<string> & turnNotifications)
       { return m_routingSession.GenerateTurnSound(turnNotifications); }