Docs: clarify getter comments to reference HardwareComponentInterface #2471
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the documentation comments in
hardware_interface/hardware_component_interface.hpp
.Previously, the getter methods (
get_clock()
,get_node()
,and
get_hardware_info()
) referred generically to "the Interface".This wording was ambiguous, since the file defines
HardwareComponentInterface
.The comments have been updated to explicitly reference
HardwareComponentInterface
, making the documentation clearerand easier for new contributors and users to follow.
No functional changes were made — this is purely a documentation fix.