Skip to content

Docs: clarify getter comments to reference HardwareComponentInterface #2471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 20, 2025
Merged

Docs: clarify getter comments to reference HardwareComponentInterface #2471

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
639b94c
docs: clarify getter comments to reference HardwareComponentInterface
rishitej04 Aug 17, 2025
db81171
Apply suggestions from code review
bmagyar Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions hardware_interface/include/hardware_interface/hardware_component_interface.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,27 +670,27 @@ class HardwareComponentInterface : public rclcpp_lifecycle::node_interfaces::Lif
return opt_value.value();
}

/// Get the logger of the Interface.
/// Get the logger of the HardwareComponentInterface.
/**
* \return logger of the Interface.
* \return logger of the HardwareComponentInterface.
*/
rclcpp::Logger get_logger() const { return logger_; }

/// Get the clock of the Interface.
/// Get the clock
/**
* \return clock of the Interface.
* \return clock that is shared with the controller manager
*/
rclcpp::Clock::SharedPtr get_clock() const { return clock_; }

/// Get the default node of the Interface.
/// Get the default node of the HardwareComponentInterface.
/**
* \return node of the Interface.
* \return node of the HardwareComponentInterface.
*/
rclcpp::Node::SharedPtr get_node() const { return hardware_component_node_; }

/// Get the hardware info of the Interface.
/// Get the hardware info of the HardwareComponentInterface.
/**
* \return hardware info of the Interface.
* \return hardware info of the HardwareComponentInterface.
*/
const HardwareInfo & get_hardware_info() const { return info_; }

Expand Down