Obbart/universal_robots_ros_driver
1
0
Fork 0
mirror of https://gitlab.com/obbart/universal_robots_ros_driver.git synced 2026-04-10 01:50:46 +02:00
Code Releases Activity

Corrected minor errors in Doxygen documentation

Browse Source
This commit is contained in:
Felix Mauch
2019-09-25 08:02:17 +02:00
parent a2e9b8a8d8
commit bca3a6d524
3 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ur_rtde_driver/include/ur_rtde_driver/comm/tcp_socket.h
View File

@@ -103,7 +103,7 @@ public:
/*! /*!
* \brief Reads one byte from the socket * \brief Reads one byte from the socket
* *
* \param character[out] Target buffer * \param[out] character Target buffer
* *
* \returns True on success, false otherwise * \returns True on success, false otherwise
*/ */

2
ur_rtde_driver/include/ur_rtde_driver/ur/tool_communication.h
View File

@@ -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. * \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. * 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) void setTxIdleChars(const TxIdleCharsT::Datatype tx_idle_chars)
{ {

16
ur_rtde_driver/include/ur_rtde_driver/ur/ur_driver.h
View File

@@ -49,8 +49,13 @@ public:
* \brief Constructs a new UrDriver object. * \brief Constructs a new UrDriver object.
* *
* \param robot_ip IP-address under which the robot is reachable. * \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 tool_comm_setup Configuration for using the tool communication * \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, 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<void(bool)> handle_program_state, const std::string& input_recipe_file, std::function<void(bool)> handle_program_state,
@@ -59,7 +64,12 @@ public:
* \brief Constructs a new UrDriver object. * \brief Constructs a new UrDriver object.
* *
* \param robot_ip IP-address under which the robot is reachable. * \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, 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<void(bool)> handle_program_state, const std::string& input_recipe_file, std::function<void(bool)> handle_program_state,