Skip to content

Commit 632f543

Browse files
EduPonzmergify[bot]
EduPonz
authored and
mergify[bot]
committed
Remove doxygen warnings (#4700, #5011) (#5016)
* Refs #21114: Remove doxygen warnings Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #21114: Apply Miguel's suggestions Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com> (cherry picked from commit 28a2e15) # Conflicts: # include/fastdds/dds/core/policy/QosPolicies.hpp # include/fastdds/dds/publisher/Publisher.hpp # include/fastdds/dds/subscriber/Subscriber.hpp
1 parent 5ad987a commit 632f543

13 files changed

Lines changed: 112 additions & 67 deletions

File tree

‎include/fastdds/dds/core/policy/QosPolicies.hpp‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2785,6 +2785,22 @@ class TransportConfigQos : public QosPolicy
27852785
* By default, 0.
27862786
*/
27872787
uint32_t listen_socket_buffer_size;
2788+
<<<<<<< HEAD
2789+
=======
2790+
2791+
//! Thread settings for the builtin transports reception threads
2792+
rtps::ThreadSettings builtin_transports_reception_threads_;
2793+
2794+
/*!
2795+
* @brief Maximum message size used to avoid fragmentation, set ONLY in LARGE_DATA.
2796+
* If this value is not zero, the network factory will allow the initialization of UDP transports with maxMessageSize
2797+
* higher than 65500K.
2798+
*/
2799+
uint32_t max_msg_size_no_frag;
2800+
2801+
//! Netmask filter configuration
2802+
fastdds::rtps::NetmaskFilterKind netmask_filter;
2803+
>>>>>>> 28a2e15f7 (Remove doxygen warnings (#4700, #5011) (#5016))
27882804
};
27892805

27902806
//! Qos Policy to configure the endpoint

‎include/fastdds/dds/domain/DomainParticipant.hpp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,7 @@ class DomainParticipant : public Entity
673673
*
674674
* @param[out] participant_handles Reference to the vector where discovered participants will be returned
675675
* @return RETCODE_OK if everything correct, error code otherwise
676+
*
676677
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
677678
*/
678679
RTPS_DllAPI ReturnCode_t get_discovered_participants(
@@ -684,6 +685,7 @@ class DomainParticipant : public Entity
684685
* @param[out] participant_data Reference to the ParticipantBuiltinTopicData object to return the data
685686
* @param participant_handle InstanceHandle of DomainParticipant to retrieve the data from
686687
* @return RETCODE_OK if everything correct, PRECONDITION_NOT_MET if participant does not exist
688+
*
687689
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
688690
*/
689691
RTPS_DllAPI ReturnCode_t get_discovered_participant_data(
@@ -695,6 +697,7 @@ class DomainParticipant : public Entity
695697
*
696698
* @param[out] topic_handles Reference to the vector where discovered topics will be returned
697699
* @return RETCODE_OK if everything correct, error code otherwise
700+
*
698701
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
699702
*/
700703
RTPS_DllAPI ReturnCode_t get_discovered_topics(

‎include/fastdds/dds/domain/DomainParticipantFactory.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ class DomainParticipantFactory
139139
* Returns all participants that belongs to the specified domain_id.
140140
*
141141
* @param domain_id
142-
* @return previously created DomainParticipants within the specified domain
142+
* @return previously created DomainParticipant instances within the specified domain
143143
*/
144144
RTPS_DllAPI std::vector<DomainParticipant*> lookup_participants(
145145
DomainId_t domain_id) const;

‎include/fastdds/dds/domain/DomainParticipantListener.hpp‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,7 @@ class DomainParticipantListener :
186186
/*!
187187
* This method is called when a participant discovers a new Type
188188
* The ownership of all object belongs to the caller so if needs to be used after the
189-
* method ends, a full copy should be perform (except for dyn_type due to its shared_ptr nature.
190-
* For example:
191-
* fastrtps::types::TypeIdentifier new_type_id = \*identifier;
189+
* method ends, a full copy should be performed (except for dyn_type due to its shared_ptr nature).
192190
*/
193191
virtual void on_type_discovery(
194192
DomainParticipant* participant,

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,7 @@ class DataWriter : public DomainEntity
514514
* @param[out] subscription_data subscription data struct
515515
* @param subscription_handle InstanceHandle_t of the subscription
516516
* @return RETCODE_OK
517+
*
517518
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
518519
*/
519520
RTPS_DllAPI ReturnCode_t get_matched_subscription_data(
@@ -525,6 +526,7 @@ class DataWriter : public DomainEntity
525526
*
526527
* @param[out] subscription_handles Vector where the InstanceHandle_t are returned
527528
* @return RETCODE_OK
529+
*
528530
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
529531
*/
530532
RTPS_DllAPI ReturnCode_t get_matched_subscriptions(

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@ class Publisher : public DomainEntity
247247
* @brief Indicates to FastDDS that the contained DataWriters are about to be modified
248248
*
249249
* @return RETCODE_OK if successful, an error code otherwise
250+
*
250251
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
251252
*/
252253
RTPS_DllAPI ReturnCode_t suspend_publications();
@@ -255,6 +256,7 @@ class Publisher : public DomainEntity
255256
* @brief Indicates to FastDDS that the modifications to the DataWriters are complete.
256257
*
257258
* @return RETCODE_OK if successful, an error code otherwise
259+
*
258260
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
259261
*/
260262
RTPS_DllAPI ReturnCode_t resume_publications();
@@ -263,6 +265,7 @@ class Publisher : public DomainEntity
263265
* @brief Signals the beginning of a set of coherent cache changes using the Datawriters attached to the publisher
264266
*
265267
* @return RETCODE_OK if successful, an error code otherwise
268+
*
266269
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
267270
*/
268271
RTPS_DllAPI ReturnCode_t begin_coherent_changes();
@@ -271,6 +274,7 @@ class Publisher : public DomainEntity
271274
* @brief Signals the end of a set of coherent cache changes
272275
*
273276
* @return RETCODE_OK if successful, an error code otherwise
277+
*
274278
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
275279
*/
276280
RTPS_DllAPI ReturnCode_t end_coherent_changes();
@@ -352,6 +356,10 @@ class Publisher : public DomainEntity
352356
* @param[out] writer_qos
353357
* @param[in] topic_qos
354358
* @return RETCODE_OK if successful, an error code otherwise
359+
<<<<<<< HEAD
360+
=======
361+
*
362+
>>>>>>> 28a2e15f7 (Remove doxygen warnings (#4700, #5011) (#5016))
355363
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
356364
*/
357365
RTPS_DllAPI ReturnCode_t copy_from_topic_qos(

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ class DataReader : public DomainEntity
136136
*
137137
* @param[in] max_wait Max blocking time for this operation.
138138
* @return RETCODE_OK if there is new unread message, ReturnCode_t::RETCODE_TIMEOUT if timeout
139+
*
139140
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
140141
*/
141142
RTPS_DllAPI ReturnCode_t wait_for_historical_data(
@@ -764,6 +765,7 @@ class DataReader : public DomainEntity
764765
* @param[in] handle
765766
*
766767
* @return Any of the standard return codes.
768+
*
767769
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
768770
*/
769771
RTPS_DllAPI ReturnCode_t get_key_value(
@@ -976,6 +978,7 @@ class DataReader : public DomainEntity
976978
* @param[out] publication_data publication data struct
977979
* @param publication_handle InstanceHandle_t of the publication
978980
* @return RETCODE_OK
981+
*
979982
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
980983
*/
981984
RTPS_DllAPI ReturnCode_t get_matched_publication_data(
@@ -987,6 +990,7 @@ class DataReader : public DomainEntity
987990
*
988991
* @param[out] publication_handles Vector where the InstanceHandle_t are returned
989992
* @return RETCODE_OK
993+
*
990994
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
991995
*/
992996
RTPS_DllAPI ReturnCode_t get_matched_publications(

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ class Subscriber : public DomainEntity
264264
* @param view_states Vector of ViewStateKind
265265
* @param instance_states Vector of InstanceStateKind
266266
* @return RETCODE_OK
267+
*
267268
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
268269
*/
269270
RTPS_DllAPI ReturnCode_t get_datareaders(
@@ -284,6 +285,7 @@ class Subscriber : public DomainEntity
284285
* attached to the Subscriber.
285286
*
286287
* @return RETCODE_OK
288+
*
287289
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
288290
*/
289291
RTPS_DllAPI ReturnCode_t begin_access();
@@ -293,6 +295,7 @@ class Subscriber : public DomainEntity
293295
* the Subscriber.
294296
*
295297
* @return RETCODE_OK
298+
*
296299
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
297300
*/
298301
RTPS_DllAPI ReturnCode_t end_access();
@@ -390,6 +393,10 @@ class Subscriber : public DomainEntity
390393
* @param[in, out] reader_qos
391394
* @param[in] topic_qos
392395
* @return RETCODE_OK if successful, an error code otherwise
396+
<<<<<<< HEAD
397+
=======
398+
*
399+
>>>>>>> 28a2e15f7 (Remove doxygen warnings (#4700, #5011) (#5016))
393400
* @warning Not supported yet. Currently returns RETCODE_UNSUPPORTED
394401
*/
395402
RTPS_DllAPI static ReturnCode_t copy_from_topic_qos(

‎include/fastdds/rtps/common/ChangeKind_t.hpp‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ namespace fastrtps {
2626
namespace rtps {
2727

2828
/**
29-
* @enum ChangeKind_t, different types of CacheChange_t.
30-
* @ingroup COMMON_MODULE
29+
* Enumerates the different types of CacheChange_t.
3130
*/
3231
enum RTPS_DllAPI ChangeKind_t
3332
{

‎include/fastdds/rtps/common/FragmentNumber.h‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,37 +19,38 @@
1919
#ifndef _FASTDDS_RTPS_RPTS_ELEM_FRAGNUM_H_
2020
#define _FASTDDS_RTPS_RPTS_ELEM_FRAGNUM_H_
2121

22+
#include <algorithm>
23+
#include <cmath>
24+
#include <set>
25+
26+
#include <fastdds/rtps/common/Types.h>
2227
#include <fastrtps/fastrtps_dll.h>
2328
#include <fastrtps/utils/fixed_size_bitmap.hpp>
24-
#include <fastdds/rtps/common/Types.h>
2529

26-
#include <set>
27-
#include <cmath>
28-
#include <algorithm>
29-
30-
namespace eprosima{
31-
namespace fastrtps{
32-
namespace rtps{
30+
namespace eprosima {
31+
namespace fastrtps {
32+
namespace rtps {
3333

3434
using FragmentNumber_t = uint32_t;
3535

3636
//!Structure FragmentNumberSet_t, contains a group of fragmentnumbers.
37-
//!@ingroup COMMON_MODULE
3837
using FragmentNumberSet_t = BitmapRange<FragmentNumber_t>;
3938

40-
inline std::ostream& operator<<(std::ostream& output, const FragmentNumberSet_t& fns)
39+
inline std::ostream& operator <<(
40+
std::ostream& output,
41+
const FragmentNumberSet_t& fns)
4142
{
4243
output << fns.base() << ":";
4344
fns.for_each([&](FragmentNumber_t it)
44-
{
45-
output << it << "-";
46-
});
45+
{
46+
output << it << "-";
47+
});
4748

4849
return output;
4950
}
5051

51-
}
52-
}
53-
}
52+
} // namespace rtps
53+
} // namespace fastrtps
54+
} // namespace eprosima
5455

5556
#endif /* _FASTDDS_RTPS_RPTS_ELEM_FRAGNUM_H_ */

0 commit comments

Comments
 (0)