From 3a457408840e1520a1db9b57f62c7755f9202d8c Mon Sep 17 00:00:00 2001 From: mvglasow Date: Sun, 19 Oct 2025 17:45:35 +0300 Subject: [PATCH] [routing] Documentation Signed-off-by: mvglasow --- libs/routing/route.hpp | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/libs/routing/route.hpp b/libs/routing/route.hpp index fecec1066..301dabca7 100644 --- a/libs/routing/route.hpp +++ b/libs/routing/route.hpp @@ -39,8 +39,21 @@ namespace routing using SubrouteUid = uint64_t; SubrouteUid constexpr kInvalidSubrouteId = std::numeric_limits::max(); -/// \brief The route is composed of one or several subroutes. Every subroute is composed of segments. -/// For every Segment is kept some attributes in the structure SegmentInfo. +/** + * @brief A segment of the route. + * + * The route is composed of one or several subroutes. Every subroute is composed of segments. + * + * For every Segment, some attributes are kept in the `SegmentInfo` structure. + * + * @todo the statement regarding `SegmentInfo` seems to be outdated, is `SegmentInfo` a prececessor + * of `RouteSegment`? + * + * Segment data which is actually related to a point, such as junction, distance and time, refer to + * the end which is closer to the end of the route. For the first segment, distance and time are the + * length and travel time of the segment itself. For the last segment, distance and time are the + * length and travel time of the entore route, and the junction is the finish point. + */ class RouteSegment final { public: