Implementation for Deadline, Liveliness, and Lifespan QoS #167
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
wjwwood
reviewed
Mar 27, 2019
| * \return `RMW_RET_OK` if successful, or | ||
| * \return `RMW_RET_BAD_ALLOC` if memory allocation failed, or | ||
| * \return `RMW_RET_ERROR` if an unexpected error occurs. | ||
| */ |
There was a problem hiding this comment.
The doc block style we use is:
/// Brief description, which is concise and a single line only.
/**
* A longer description.
*
* Perhaps with detailed explanation of the behavior of the function.
* But always, one sentence per line.
* Another sentence is here.
*
* \param[in] input An input argument.
* \param[out] output An output argument.
* \return `RMW_RET_OK` if successful, or
* \return `RMW_RET_BAD_ALLOC` if memory allocation failed, or
* \return `RMW_RET_ERROR` if an unexpected error occurs.
*/
...
Note the differences, like /** at the start, the brief being on it's own /// line, the param's having in/out designations, etc.
Also the taken argument is not documented.
| @@ -239,6 +299,154 @@ typedef enum RMW_PUBLIC_TYPE | |||
| RMW_LOG_SEVERITY_FATAL = RCUTILS_LOG_SEVERITY_FATAL | |||
| } rmw_log_severity_t; | |||
|
|
|||
| /// Defined in the DDS SSpec 15-04-10 section 2.2.4.1 Communication Status | |||
There was a problem hiding this comment.
This doesn't seem like a brief description for the struct, so either reformat it so that it is, or consider just using //.
| typedef struct RMW_LIVELINESS_CHANGED_STATUS | ||
| { | ||
| /** | ||
| * The total number of currently active DataWriters that write the Topic read by the DataReader. |
There was a problem hiding this comment.
The rmw documentation should not speak about DDS concepts like DataWriter, etc.. It needs to be in generic terms that are not tied to a specific rmw implementation.
This was referenced Mar 28, 2019
|
Closing this pull request in favor of #171. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Implementation for Deadline, Liveliness, and Lifespan QoS. The design is at ros2/design#212
This is currently a work in progress.