Skip to content

Commit 605718c

Browse files
authored
Docs: clarify getter comments to reference HardwareComponentInterface (#2471)
1 parent cc83667 commit 605718c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

hardware_interface/include/hardware_interface/hardware_component_interface.hpp

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -670,27 +670,27 @@ class HardwareComponentInterface : public rclcpp_lifecycle::node_interfaces::Lif
670670
return opt_value.value();
671671
}
672672

673-
/// Get the logger of the Interface.
673+
/// Get the logger of the HardwareComponentInterface.
674674
/**
675-
* \return logger of the Interface.
675+
* \return logger of the HardwareComponentInterface.
676676
*/
677677
rclcpp::Logger get_logger() const { return logger_; }
678678

679-
/// Get the clock of the Interface.
679+
/// Get the clock
680680
/**
681-
* \return clock of the Interface.
681+
* \return clock that is shared with the controller manager
682682
*/
683683
rclcpp::Clock::SharedPtr get_clock() const { return clock_; }
684684

685-
/// Get the default node of the Interface.
685+
/// Get the default node of the HardwareComponentInterface.
686686
/**
687-
* \return node of the Interface.
687+
* \return node of the HardwareComponentInterface.
688688
*/
689689
rclcpp::Node::SharedPtr get_node() const { return hardware_component_node_; }
690690

691-
/// Get the hardware info of the Interface.
691+
/// Get the hardware info of the HardwareComponentInterface.
692692
/**
693-
* \return hardware info of the Interface.
693+
* \return hardware info of the HardwareComponentInterface.
694694
*/
695695
const HardwareInfo & get_hardware_info() const { return info_; }
696696

0 commit comments

Comments
 (0)