Improved docstring consistency across the codebase #2087
Conversation
github-actions
bot
requested review from
aprotyas,
arne48,
christophfroehlich,
fmauch,
LukasMacha97,
olivier-stasse and
saikishor
.vscode/settings.json
Outdated
There was a problem hiding this comment.
Please remove this.
| /** | ||
| * \return name. | ||
| */ | ||
| /// Gets the name of the actuator hardware. |
There was a problem hiding this comment.
do we need the lines starting with /// across all files?
There was a problem hiding this comment.
I followed the existing style in most files but can update it if needed. Would you like me to revert /// to /** ... */ in some places?
There was a problem hiding this comment.
I don't think we need this information within /// and then in the @brief again?
There was a problem hiding this comment.
I believe it is not compiling for this. Please fix it and make sure the project compiles. Also, please install pre-commit as @christophfroehlich already mentioned.
|
I can imagine that this was a lot of work. But with respect to the huge amount of changes, could you please split this PR into smaller portions? For example, first fixing the format/syntax of the docstring in one PR without changing/rephrasing them? |
Co-authored-by: Sai Kishor Kothakota <[email protected]>
| * the controller can be activated and to claim interfaces from the hardware. | ||
| * | ||
| * The claimed interfaces are populated in the | ||
| * `ControllerInterfaceBase::state_interfaces_` member. |
There was a problem hiding this comment.
Things like * \ref ControllerInterfaceBase::state_interfaces_ "state_interfaces_" member. create hyperlink to that class in doxygen. Is that not the case anymore?
Hello Developers,
This is my 1st contribution to open source, and I'm excited to contribute to this project!
This PR Fixes : #2064
Changes Made:
I have carefully reviewed my changes, but I would love your feedback!
Looking forward to your review and suggestions.
@christophfroehlich @saikishor
Regards,
Vishwanath Karne