]> rtime.felk.cvut.cz Git - hubacji1/bcar.git/commitdiff
Rewrite drivable docstring
authorJiri Vlasak <hubacji1@fel.cvut.cz>
Fri, 16 Jul 2021 13:47:29 +0000 (15:47 +0200)
committerJiri Vlasak <jiri.vlasak.2@cvut.cz>
Tue, 20 Jul 2021 14:49:17 +0000 (16:49 +0200)
incl/bcar.hh

index 1ca3a7a0306dd52791546bee5c21abbe651e5351..03609968aaecc6b80a9f417700a567476703af37 100644 (file)
@@ -283,10 +283,10 @@ class BicycleCar : public virtual Pose, public virtual CarSize,
                public virtual CarMove {
 private:
 public:
-       /*! \brief Return `false` if `bc` is not achievable.
+       /*! \brief Return `true` if `this` can drive to `p` trivially.
         *
-        * When `false` is returned the `bc` may still be drivable, but not
-        * trivially, i.e. by "line segment - circle arc - line segment".
+        * Trivially means that `this` can drive to `p` by line segment - circle
+        * arc - line segment.
         *
         * \param p `PoseRange` (resp. `Pose`) to achieve.
         */