[routing] Documentation

Signed-off-by: mvglasow <michael -at- vonglasow.com>
This commit is contained in:
mvglasow
2025-07-01 21:02:14 +03:00
parent 9eeac05fdf
commit 4324e329e5
2 changed files with 17 additions and 5 deletions

View File

@@ -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();