Skip to content

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
Signed-off-by: Chen Lihui <[email protected]>
  • Loading branch information
Chen Lihui authored and Chen Lihui committed Mar 11, 2021
1 parent d51b165 commit 32898ec
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions rcl/include/rcl/subscription.h
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ RCL_WARN_UNUSED
rcl_ret_t
rcl_subscription_options_fini(rcl_subscription_options_t * option);

/// Check if the content filter topic feature is supported in the subscription.
/// Check if the content filtered topic feature is supported in the subscription.
/**
* Depending on the middleware and whether cft is supported in the subscription.
* this will return true if the middleware can support ContentFilteredTopic in the subscription.
Expand All @@ -250,9 +250,15 @@ rcl_subscription_is_cft_supported(const rcl_subscription_t * subscription);
* Lock-Free | Maybe [1]
*
* \param[in] subscription the subscription object to inspect.
* \param[in] filter_expression A filter expression to set.
* \param[in] expression_parameters Array of expression parameters to set,
* it can be NULL if there is no placeholder in filter_expression.
* \param[in] filter_expression A filter_expression is a string that specifies the criteria
* to select the data samples of interest. It is similar to the WHERE part of an SQL clause.
* Using an empty("") string can reset/clean content filtered topic for the subscription.
* \param[in] expression_parameters An expression_parameters is an array of strings that
* give values to the ‘parameters’ (i.e., "%n" tokens begin from 0) in the filter_expression.
* The number of supplied parameters must fit with the requested values in the filter_expression.
* It can be NULL if there is no "%n" tokens placeholder in filter_expression.
* The maximun size allowance depends on concrete DDS vendor.
* (i.e., it cannot be greater than 100 on RTI_Connext.)
* \return `RCL_RET_OK` if the query was successful, or
* \return `RCL_RET_INVALID_ARGUMENT` if `subscription` is NULL, or
* \return `RCL_RET_INVALID_ARGUMENT` if `filter_expression` is NULL, or
Expand Down

0 comments on commit 32898ec

Please sign in to comment.