Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mapsme/omim.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVladimir Byko-Ianko <v.bykoianko@corp.mail.ru>2020-09-25 12:35:36 +0300
committermpimenov <mpimenov@users.noreply.github.com>2020-10-21 17:29:58 +0300
commit717f8c90b31858ecb5deb818c38eafaee481de74 (patch)
tree34792844118ec65f524c165335136af0a9f27246 /routing
parent8bfd171aad148c891ba5bfba443b16ee47ee298f (diff)
[routing] Review fixes.
Diffstat (limited to 'routing')
-rw-r--r--routing/route.hpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/routing/route.hpp b/routing/route.hpp
index 82a7a00f4d..781138f241 100644
--- a/routing/route.hpp
+++ b/routing/route.hpp
@@ -293,14 +293,13 @@ public:
double GetCurrentDistanceToEndMeters() const;
double GetMercatorDistanceFromBegin() const;
- /// \brief GetCurrentTurn returns information about the nearest turn.
+ /// \brief Extracts information about the nearest turn according to the route.
/// \param distanceToTurnMeters is a distance from current position to the nearest turn.
/// \param turn is information about the nearest turn.
void GetCurrentTurn(double & distanceToTurnMeters, turns::TurnItem & turn) const;
- /// \brief Extracts information about turn RouteSegment according to current iterator
- /// set with MoveIterator() method.
- /// \returns true if |turn| is filled correctly and false otherwise.
+ /// \returns information about turn from RouteSegment according to current iterator
+ /// set with MoveIterator() method. If it's not possible returns nullopt.
std::optional<turns::TurnItem> GetCurrentIteratorTurn() const;
/// \brief Returns a name of a street where the user rides at this moment.
@@ -422,6 +421,7 @@ private:
std::vector<platform::CountryFile> m_speedCamPartlyProhibitedMwms;
};
-/// \returns true if |turn| is equal to turns::CarDirection::None or |turns::PedestrianDirection::None|.
+/// \returns true if |turn| is not equal to turns::CarDirection::None or
+/// |turns::PedestrianDirection::None|.
bool IsNormalTurn(turns::TurnItem const & turn);
} // namespace routing