Add comments to composition demo #97
Conversation
dhood
added
in review
| /** | ||
| * Create a callback function for when messages are received. | ||
| * Variations of this function also exist using, for example, UniquePtr for zero-copy transport. | ||
| */ |
There was a problem hiding this comment.
Should these be line comments rather then block comments. Doxygen (/**) would also not extract those I assume?
I think this is good in order to avoid confusion with doxygen comments. Doxygen would not have extract most of these anyways (since many are not attached functions, classes, or attribute declarations).
|
I updated this to use line comments in order to fix the inconsistent indentation and to avoid confusion with doxygen and to save vertical lines. I don't think we were planning on running doxygen on this anyways. |
|
Still one file with block comments. |
|
It's fixed. |
|
Block comments are used in ROS 1 tutorials so I was following that |
Ah, that makes sense. I was just updating it to follow our developer guide:
Both paths were probably fine, but I switched it when touching things to fix the indentation issues. |
No description provided.