From: Jiri Vlasak <jiri.vlasak.2@cvut.cz>
Date: Thu, 18 Aug 2022 12:49:16 +0000 (+0200)
Subject: Improve docs for (collision) ext 20
X-Git-Tag: v0.13.0~1
X-Git-Url: http://rtime.felk.cvut.cz/gitweb/hubacji1/rrts.git/commitdiff_plain/576e50a054c6bc57c11929299787330cefc4f091

Improve docs for (collision) ext 20
---

diff --git a/incl/rrtext.hh b/incl/rrtext.hh
index 87d39c4..d8bcfd6 100644
--- a/incl/rrtext.hh
+++ b/incl/rrtext.hh
@@ -39,6 +39,10 @@
 namespace rrts {
 
 /*! \brief Collision check based on occupancy grid.
+ *
+ * This approach expects obstacles to be represented by points and the collision
+ * occures whenever the point is inside the frame given by the car pose and the
+ * car size.
  *
  * \ingroup ext-col
  */