Update pololu related classes to indicate that baudrate is only used …

…on Windows
lagadic · Nov 17, 2023 · 39f501c · 39f501c
1 parent cb4642d
commit 39f501c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/modules/robot/include/visp3/robot/vpPololu.h b/modules/robot/include/visp3/robot/vpPololu.h
@@ -89,7 +89,7 @@ class VISP_EXPORT vpPololu
    * You can set velocity commands using setPwmVelocity() or setAngularVelocity().
    *
    * \param[in] device : Serial device name to dial with Pololu board.
-   * \param[in] baudrate : Baudrate used to dial with Pololu board.
+   * \param[in] baudrate : Baudrate used to dial with Pololu board. Note that this parameter is only used on Windows.
    * \param[in] channel : Channel to which the servo is connected to the Pololu board.
    * \param[in] verbose : When true enable verbose mode.
    */
@@ -113,7 +113,7 @@ class VISP_EXPORT vpPololu
    * Open a connection with the Pololu board.
    *
    * \param[in] device : Serial device name to dial with Pololu board.
-   * \param[in] baudrate : Baudrate used to dial with Pololu board.
+   * \param[in] baudrate : Baudrate used to dial with Pololu board. Note that this parameter is only used on Windows.
    * \param[in] channel : Channel to which the servo is connected to the Pololu board.
    */
   void connect(const std::string &device, int baudrate, int channel);

diff --git a/modules/robot/include/visp3/robot/vpRobotPololuPtu.h b/modules/robot/include/visp3/robot/vpRobotPololuPtu.h
@@ -68,7 +68,7 @@ class VISP_EXPORT vpRobotPololuPtu : public vpRobot
    * Default constructor.
    *
    * \param[in] device : Name of the serial interface used for communication.
-   * \param[in] baudrate : Baudrate used for the serial communication.
+   * \param[in] baudrate : Baudrate used for the serial communication. Note that this parameter is only used on Windows.
    * \param[in] verbose : When true, enable verbose mode.
    */
   vpRobotPololuPtu(const std::string &device = "/dev/ttyACM0", int baudrate = 9600, bool verbose = false);