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

Jump to bottom

update doxygen style to ros2 core #202

Closed

Karsten1987 opened this issue Oct 22, 2020 · 0 comments · Fixed by #300

Labels

good first issue help wanted

Contributor

Karsten1987 commented Oct 22, 2020 •

edited

Loading

We're currently using a different style of doxygen than the rest of the ros2 core packages. We should adapt their style in the form of

/// Some brief instruction
/**
 * more details, more description
 * 
 * \param [in/out] <type> description
 * \return <type> description
 */
void some_func();

examples can be found here: https://github.com/ros2/rclcpp/blob/master/rclcpp/include/rclcpp/node.hpp#L79-L84

The text was updated successfully, but these errors were encountered:

Karsten1987 added help wanted good first issue labels

BorgesJVT mentioned this issue

update doxygen style according to ros2 core standard #300

Merged

Karsten1987 closed this as completed in #300

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment