diff --git a/routing/absent_regions_finder.hpp b/routing/absent_regions_finder.hpp index 0f1541020..a79fad151 100644 --- a/routing/absent_regions_finder.hpp +++ b/routing/absent_regions_finder.hpp @@ -14,8 +14,12 @@ namespace routing { using LocalFileCheckerFn = std::function; -// Encapsulates generation of mwm names of absent regions needed for building the route between -// |checkpoints|. For this purpose the new thread is used. +/** + * @brief Generates a list of MWMs needed to build a route. + * + * The `AbsentRegionsFinder` class encapsulates generation of MWM names of absent regions needed + * for building the route between `checkpoints`. For this purpose a separate worker thread is used. + */ class AbsentRegionsFinder { public: @@ -23,7 +27,11 @@ public: LocalFileCheckerFn const & localFileChecker, std::shared_ptr numMwmIds, DataSource & dataSource); - // Creates new thread |m_routerThread| and starts routing in it. + /** + * @brief Creates new thread `m_routerThread` and starts routing in it. + * @param checkpoints The checkpoints of the route (start, optional intermediate points, destination) + * @param delegate + */ void GenerateAbsentRegions(Checkpoints const & checkpoints, RouterDelegate const & delegate); /** diff --git a/routing/async_router.hpp b/routing/async_router.hpp index d9c70f09f..26690a227 100644 --- a/routing/async_router.hpp +++ b/routing/async_router.hpp @@ -23,11 +23,15 @@ namespace routing { -/// Dispatches a route calculation on a worker thread +/** + * @brief The AsyncRouter class is a wrapper class to run routing routines in a different thread. + * + * It encapsulates an `IRouter` (or subclass) instance, set with `SetRouter()`, and runs it in a + * separate worker thread to calculate the route. + */ class AsyncRouter final { public: - /// AsyncRouter is a wrapper class to run routing routines in the different thread AsyncRouter(PointCheckCallback const & pointCheckCallback); ~AsyncRouter();