Improve docs for (collision) ext 20

[hubacji1/rrts.git] / incl / rrtext.hh

diff --git a/incl/rrtext.hh b/incl/rrtext.hh
index 87d39c4bc25d47f8915a96f906e60b60ec6164f2..d8bcfd6eed1c4bcd4a37da59b0950b4a04123927 100644 (file)
--- 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
  */