Skip to content

Commit 10f88d3

Browse files
EduPonzJesusPoderoso
EduPonz
authored and
JesusPoderoso
committed
Adjust doxygen so Fast DDS Python pydoc makes RTD build (#5026)
* Refs #21114: Fix dispose Signed-off-by: eduponz <eduardoponz@eprosima.com> Refs #21114: Split return into several @return Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix register_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix unregister_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix read_next_instance_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_next_instance Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Fix take_next_instance_w_condition Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
1 parent d488cfd commit 10f88d3

2 files changed

Lines changed: 54 additions & 50 deletions

File tree

‎include/fastdds/dds/publisher/DataWriter.hpp‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,12 +198,14 @@ class DataWriter : public DomainEntity
198198

199199
/*!
200200
* @brief Informs that the application will be modifying a particular instance.
201+
*
201202
* It gives an opportunity to the middleware to pre-configure itself to improve performance.
203+
* The returned handle could be used in successive `write` or `dispose` operations.
202204
*
203205
* @param[in] instance Sample used to get the instance's key.
206+
*
204207
* @return Handle containing the instance's key.
205-
* This handle could be used in successive `write` or `dispose` operations.
206-
* In case of error, HANDLE_NIL will be returned.
208+
* @return HANDLE_NIL in case of error.
207209
*/
208210
RTPS_DllAPI InstanceHandle_t register_instance(
209211
void* instance);
@@ -246,8 +248,8 @@ class DataWriter : public DomainEntity
246248
*
247249
* @param[in] instance Sample used to deduce instance's key in case of `handle` parameter is HANDLE_NIL.
248250
* @param[in] handle Instance's key to be unregistered.
249-
* @return Returns the operation's result.
250-
* If the operation finishes successfully, ReturnCode_t::RETCODE_OK is returned.
251+
*
252+
* @return ReturnCode_t
251253
*/
252254
RTPS_DllAPI ReturnCode_t unregister_instance(
253255
void* instance,
@@ -447,8 +449,10 @@ class DataWriter : public DomainEntity
447449
*
448450
* @param[in] data Sample used to deduce instance's key in case of `handle` parameter is HANDLE_NIL.
449451
* @param[in] handle InstanceHandle of the data
450-
* @return RETCODE_PRECONDITION_NOT_MET if the handle introduced does not match with the one associated to the data,
451-
* RETCODE_OK if the data is correctly sent and RETCODE_ERROR otherwise.
452+
*
453+
* @return RETCODE_PRECONDITION_NOT_MET if the handle introduced does not match with the one associated to the data.
454+
* @return RETCODE_OK if the data is correctly sent.
455+
* @return RETCODE_ERROR otherwise.
452456
*/
453457
RTPS_DllAPI ReturnCode_t dispose(
454458
void* data,

‎include/fastdds/dds/subscriber/DataReader.hpp‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ class DataReader : public DomainEntity
455455
* This operation accesses a collection of Data values from the DataReader. The behavior is identical to
456456
* @ref read_next_instance except that all samples returned satisfy the specified condition. In other words, on
457457
* success all returned samples belong to the same instance, and the instance is the instance with
458-
* ‘smallest’ @c instance_handle among the ones that verify (a) @c instance_handle >= @c previous_handle and (b) have samples
458+
* 'smallest' @c instance_handle among the ones that verify (a) @c instance_handle >= @c previous_handle and (b) have samples
459459
* for which the specified ReadCondition evaluates to TRUE.
460460
*
461461
* Similar to the operation @ref read_next_instance it is possible to call
@@ -464,19 +464,19 @@ class DataReader : public DomainEntity
464464
*
465465
* The behavior of the @ref read_next_instance_w_condition operation follows the same rules than the read operation
466466
* regarding the pre-conditions and post-conditions for the @c data_values and @c sample_infos collections. Similar
467-
* to read, the @ref read_next_instance_w_condition operation may ‘loan’ elements to the output collections which
467+
* to read, the @ref read_next_instance_w_condition operation may 'loan' elements to the output collections which
468468
* must then be returned by means of @ref return_loan.
469469
*
470470
* If the DataReader has no samples that meet the constraints, the return value will be RETCODE_NO_DATA.
471471
*
472-
* @param[in,out] data_values A LoanableCollection object where the received data samples will be returned.
473-
* @param[in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
474-
* @param[in] max_samples The maximum number of samples to be returned. If the special value
475-
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
476-
* available, up to the limits described in the documentation for @ref read().
477-
* @param[in] previous_handle The 'next smallest' instance with a value greater than this value that has
478-
* available samples will be returned.
479-
* @param[in] a_condition A ReadCondition that returned @c data_values must pass
472+
* @param [in,out] data_values A LoanableCollection object where the received data samples will be returned.
473+
* @param [in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
474+
* @param [in] max_samples The maximum number of samples to be returned. If the special value
475+
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
476+
* available, up to the limits described in the documentation for @ref read().
477+
* @param [in] previous_handle The 'next smallest' instance with a value greater than this value that has
478+
* available samples will be returned.
479+
* @param [in] a_condition A ReadCondition that returned @c data_values must pass
480480
*
481481
* @return Any of the standard return codes.
482482
*/
@@ -562,11 +562,11 @@ class DataReader : public DomainEntity
562562
*
563563
* If the DataReader has no samples that meet the constraints, the return value will be RETCODE_NO_DATA.
564564
*
565-
* @param[in,out] data_values A LoanableCollection object where the received data samples will be returned.
566-
* @param[in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
567-
* @param[in] max_samples The maximum number of samples to be returned. If the special value
568-
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are.
569-
* @param[in] a_condition A ReadCondition that returned @c data_values must pass
565+
* @param [in,out] data_values A LoanableCollection object where the received data samples will be returned.
566+
* @param [in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
567+
* @param [in] max_samples The maximum number of samples to be returned. If the special value
568+
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are.
569+
* @param [in] a_condition A ReadCondition that returned @c data_values must pass
570570
*
571571
* @return Any of the standard return codes.
572572
*/
@@ -590,17 +590,17 @@ class DataReader : public DomainEntity
590590
*
591591
* If the DataReader has no samples that meet the constraints, the operations fails with RETCODE_NO_DATA.
592592
*
593-
* @param[in,out] data_values A LoanableCollection object where the received data samples will be returned.
594-
* @param[in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
595-
* @param[in] max_samples The maximum number of samples to be returned. If the special value
596-
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
597-
* available, up to the limits described in the documentation for @ref read().
598-
* @param[in] a_handle The specified instance to return samples for. The method will fail with
599-
* RETCODE_BAD_PARAMETER if the handle does not correspond to an existing
600-
* data-object known to the DataReader.
601-
* @param[in] sample_states Only data samples with @c sample_state matching one of these will be returned.
602-
* @param[in] view_states Only data samples with @c view_state matching one of these will be returned.
603-
* @param[in] instance_states Only data samples with @c instance_state matching one of these will be returned.
593+
* @param [in,out] data_values A LoanableCollection object where the received data samples will be returned.
594+
* @param [in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
595+
* @param [in] max_samples The maximum number of samples to be returned. If the special value
596+
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
597+
* available, up to the limits described in the documentation for @ref read().
598+
* @param [in] a_handle The specified instance to return samples for. The method will fail with
599+
* RETCODE_BAD_PARAMETER if the handle does not correspond to an existing
600+
* data-object known to the DataReader.
601+
* @param [in] sample_states Only data samples with @c sample_state matching one of these will be returned.
602+
* @param [in] view_states Only data samples with @c view_state matching one of these will be returned.
603+
* @param [in] instance_states Only data samples with @c instance_state matching one of these will be returned.
604604
*
605605
* @return Any of the standard return codes.
606606
*/
@@ -630,16 +630,16 @@ class DataReader : public DomainEntity
630630
*
631631
* If the DataReader has no samples that meet the constraints, the operations fails with RETCODE_NO_DATA.
632632
*
633-
* @param[in,out] data_values A LoanableCollection object where the received data samples will be returned.
634-
* @param[in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
635-
* @param[in] max_samples The maximum number of samples to be returned. If the special value
636-
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
637-
* available, up to the limits described in the documentation for @ref read().
638-
* @param[in] previous_handle The 'next smallest' instance with a value greater than this value that has
639-
* available samples will be returned.
640-
* @param[in] sample_states Only data samples with @c sample_state matching one of these will be returned.
641-
* @param[in] view_states Only data samples with @c view_state matching one of these will be returned.
642-
* @param[in] instance_states Only data samples with @c instance_state matching one of these will be returned.
633+
* @param [in,out] data_values A LoanableCollection object where the received data samples will be returned.
634+
* @param [in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
635+
* @param [in] max_samples The maximum number of samples to be returned. If the special value
636+
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
637+
* available, up to the limits described in the documentation for @ref read().
638+
* @param [in] previous_handle The 'next smallest' instance with a value greater than this value that has
639+
* available samples will be returned.
640+
* @param [in] sample_states Only data samples with @c sample_state matching one of these will be returned.
641+
* @param [in] view_states Only data samples with @c view_state matching one of these will be returned.
642+
* @param [in] instance_states Only data samples with @c instance_state matching one of these will be returned.
643643
*
644644
* @return Any of the standard return codes.
645645
*/
@@ -669,14 +669,14 @@ class DataReader : public DomainEntity
669669
*
670670
* If the DataReader has no samples that meet the constraints, the return value will be RETCODE_NO_DATA
671671
*
672-
* @param[in,out] data_values A LoanableCollection object where the received data samples will be returned.
673-
* @param[in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
674-
* @param[in] max_samples The maximum number of samples to be returned. If the special value
675-
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
676-
* available, up to the limits described in the documentation for @ref read().
677-
* @param[in] previous_handle The 'next smallest' instance with a value greater than this value that has
678-
* available samples will be returned.
679-
* @param[in] a_condition A ReadCondition that returned @c data_values must pass
672+
* @param [in,out] data_values A LoanableCollection object where the received data samples will be returned.
673+
* @param [in,out] sample_infos A SampleInfoSeq object where the received sample info will be returned.
674+
* @param [in] max_samples The maximum number of samples to be returned. If the special value
675+
* @ref LENGTH_UNLIMITED is provided, as many samples will be returned as are
676+
* available, up to the limits described in the documentation for @ref read().
677+
* @param [in] previous_handle The 'next smallest' instance with a value greater than this value that has
678+
* available samples will be returned.
679+
* @param [in] a_condition A ReadCondition that returned @c data_values must pass
680680
*
681681
* @return Any of the standard return codes.
682682
*/

0 commit comments

Comments
 (0)