From bca3a6d524c0a0c07add3e182b8751148ee6a36a Mon Sep 17 00:00:00 2001 From: Felix Mauch Date: Wed, 25 Sep 2019 08:02:17 +0200 Subject: [PATCH] Corrected minor errors in Doxygen documentation --- .../include/ur_rtde_driver/comm/tcp_socket.h | 2 +- .../ur_rtde_driver/ur/tool_communication.h | 2 +- .../include/ur_rtde_driver/ur/ur_driver.h | 16 +++++++++++++--- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/ur_rtde_driver/include/ur_rtde_driver/comm/tcp_socket.h b/ur_rtde_driver/include/ur_rtde_driver/comm/tcp_socket.h index 7c7b8b4..6d8c152 100644 --- a/ur_rtde_driver/include/ur_rtde_driver/comm/tcp_socket.h +++ b/ur_rtde_driver/include/ur_rtde_driver/comm/tcp_socket.h @@ -103,7 +103,7 @@ public: /*! * \brief Reads one byte from the socket * - * \param character[out] Target buffer + * \param[out] character Target buffer * * \returns True on success, false otherwise */ diff --git a/ur_rtde_driver/include/ur_rtde_driver/ur/tool_communication.h b/ur_rtde_driver/include/ur_rtde_driver/ur/tool_communication.h index d92ea09..a2cdb9e 100644 --- a/ur_rtde_driver/include/ur_rtde_driver/ur/tool_communication.h +++ b/ur_rtde_driver/include/ur_rtde_driver/ur/tool_communication.h @@ -213,7 +213,7 @@ public: * \brief Setup the tool communication number of idle chars for the tx channel that will be configured on the robot. * This will not immediately change values on the robot, it will only be stored inside the ToolCommSetup object. * - * \param rx_idle_chars must be inside [0.0, 40] or this will throw an exception. + * \param tx_idle_chars must be inside [0.0, 40] or this will throw an exception. */ void setTxIdleChars(const TxIdleCharsT::Datatype tx_idle_chars) { diff --git a/ur_rtde_driver/include/ur_rtde_driver/ur/ur_driver.h b/ur_rtde_driver/include/ur_rtde_driver/ur/ur_driver.h index 9128ea5..90b6c8f 100644 --- a/ur_rtde_driver/include/ur_rtde_driver/ur/ur_driver.h +++ b/ur_rtde_driver/include/ur_rtde_driver/ur/ur_driver.h @@ -49,8 +49,13 @@ public: * \brief Constructs a new UrDriver object. * * \param robot_ip IP-address under which the robot is reachable. - * \param script_file URScript file that should be sent to the robot - * \param tool_comm_setup Configuration for using the tool communication + * \param script_file URScript file that should be sent to the robot. + * \param output_recipe_file Filename where the output recipe is stored in. + * \param input_recipe_file Filename where the input recipe is stored in. + * \param handle_program_state Function handle to a callback on program state changes. + * \param tool_comm_setup Configuration for using the tool communication. + * \param calibration_checksum Expected checksum of calibration. Will be matched against the + * calibration reported by the robot. */ UrDriver(const std::string& robot_ip, const std::string& script_file, const std::string& output_recipe_file, const std::string& input_recipe_file, std::function handle_program_state, @@ -59,7 +64,12 @@ public: * \brief Constructs a new UrDriver object. * * \param robot_ip IP-address under which the robot is reachable. - * \param script_file URScript file that should be sent to the robot + * \param script_file URScript file that should be sent to the robot. + * \param output_recipe_file Filename where the output recipe is stored in. + * \param input_recipe_file Filename where the input recipe is stored in. + * \param handle_program_state Function handle to a callback on program state changes. + * \param calibration_checksum Expected checksum of calibration. Will be matched against the + * calibration reported by the robot. */ UrDriver(const std::string& robot_ip, const std::string& script_file, const std::string& output_recipe_file, const std::string& input_recipe_file, std::function handle_program_state,