From 8525d8ee0ae2758cd510065c0333832060126bba Mon Sep 17 00:00:00 2001 From: Eduardo Ponz Segrelles Date: Wed, 5 Jun 2024 12:16:12 +0200 Subject: [PATCH] Fix Doxygen errors for Doxygen versions prior to 1.8.19 (#4896) Signed-off-by: eduponz --- .../type_representation/TypeObjectUtils.hpp | 26 +++++++++---------- .../TypeObjectRegistry.hpp | 26 +++++++++---------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/include/fastdds/dds/xtypes/type_representation/TypeObjectUtils.hpp b/include/fastdds/dds/xtypes/type_representation/TypeObjectUtils.hpp index 5f222afed0f..294d3c1e1a7 100644 --- a/include/fastdds/dds/xtypes/type_representation/TypeObjectUtils.hpp +++ b/include/fastdds/dds/xtypes/type_representation/TypeObjectUtils.hpp @@ -249,7 +249,7 @@ class TypeObjectUtils * * @tparam array Either a SBoundSeq or LBoundSeq. * @tparam element Either a SBound or LBound. - * @param[in out] array_bound_seq Sequence with the array bounds. + * @param[in,out] array_bound_seq Sequence with the array bounds. * @param[in] dimension_bound Dimension bound to be added into the sequence. */ template @@ -716,7 +716,7 @@ class TypeObjectUtils /** * @brief Add AppliedAnnotationParameter to the sequence. * - * @param[in out] param_seq AppliedAnnotationParameter sequence to be modified. + * @param[in,out] param_seq AppliedAnnotationParameter sequence to be modified. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if the parameter being added has * already been included in the sequence. * @param[in] param AppliedAnnotationParameter to be added. @@ -745,7 +745,7 @@ class TypeObjectUtils /** * @brief Add AppliedAnnotation to the sequence. * - * @param[in out] ann_custom_seq AppliedAnnotation sequence to be modified. + * @param[in,out] ann_custom_seq AppliedAnnotation sequence to be modified. * @param[in] ann_custom AppliedAnnotation to be added. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if: * 1. Given AppliedAnnotation is not consistent (only in Debug build mode). @@ -837,7 +837,7 @@ class TypeObjectUtils /** * @brief Add CompleteStructMember to the sequence. * - * @param[in out] member_seq CompleteStructMember sequence to be modified. + * @param[in,out] member_seq CompleteStructMember sequence to be modified. * @param[in] member CompleteStructMember to be added. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if: * 1. Given CompleteStructMember is not consistent (only in Debug build mode). @@ -928,7 +928,7 @@ class TypeObjectUtils /** * @brief Add label to the union case label sequence. * - * @param[in out] label_seq Sequence to be modified. + * @param[in,out] label_seq Sequence to be modified. * @param[in] label Label to be added. */ FASTDDS_EXPORTED_API static void add_union_case_label( @@ -970,7 +970,7 @@ class TypeObjectUtils /** * @brief Add CompleteUnionMember to sequence. * - * @param[in out] complete_union_member_seq Sequence to be modified. + * @param[in,out] complete_union_member_seq Sequence to be modified. * @param[in] member Complete union member to be added. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if: * 1. Given CompleteUnionMember is not consistent (only in Debug build mode). @@ -1105,7 +1105,7 @@ class TypeObjectUtils /** * @brief Add CompleteAnnotationParameter to sequence. * - * @param[in out] sequence Sequence to be modified. + * @param[in,out] sequence Sequence to be modified. * @param[in] param Complete annotation parameter to be added. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if: * 1. Given CompleteAnnotationParameter is not consistent (only in Debug build mode). @@ -1438,7 +1438,7 @@ class TypeObjectUtils * @brief Add CompleteEnumeratedLiteral to sequence. * * @param[in] sequence Sequence to be modified. - * @param[in out] enum_literal CompleteEnumeratedLiteral to be added. + * @param[in,out] enum_literal CompleteEnumeratedLiteral to be added. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if: * 1. Given CommonEnumeratedLiteral is not consistent (only in Debug build mode). * 2. There is already another literal in the sequence with the same value or the same member name @@ -1545,7 +1545,7 @@ class TypeObjectUtils /** * @brief Add complete bitflag to the sequence. * - * @param[in out] sequence Sequence to be modified. + * @param[in,out] sequence Sequence to be modified. * @param[in] bitflag CompleteBitflag to be added. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if: * 1. Given bitflag is inconsistent (only in Debug build mode). @@ -1626,7 +1626,7 @@ class TypeObjectUtils /** * @brief Add complete bitfield to the sequence. * - * @param[in out] sequence Sequence to be modified. + * @param[in,out] sequence Sequence to be modified. * @param[in] bitfield CompleteBitfield to be added. * @exception eprosima::fastdds::dds::xtypes::InvalidArgumentError exception if: * 1. Given bitfield is inconsistent (only in Debug build mode). @@ -1898,7 +1898,7 @@ class TypeObjectUtils /** * @brief Set the try construct behavior in a given MemberFlag * - * @param[in out] member_flag Bitmask to be set. + * @param[in,out] member_flag Bitmask to be set. * @param[in] try_construct_kind TryConstructKind. */ static void set_try_construct_behavior( @@ -1908,7 +1908,7 @@ class TypeObjectUtils /** * @brief Set the TypeFlag object. * - * @param[in out] type_flag Bitmask to be set. + * @param[in,out] type_flag Bitmask to be set. * @param[in] extensibility_kind ExtensibilityKind * @param[in] nested nested annotation value. * @param[in] autoid_hash autoid annotation has HASH value. @@ -1922,7 +1922,7 @@ class TypeObjectUtils /** * @brief Set the extensibility kind in a given TypeFlag. * - * @param[in out] type_flag Bitmask to be set. + * @param[in,out] type_flag Bitmask to be set. * @param[in] extensibility_kind ExtensibilityKind. */ static void set_extensibility_kind( diff --git a/src/cpp/fastdds/xtypes/type_representation/TypeObjectRegistry.hpp b/src/cpp/fastdds/xtypes/type_representation/TypeObjectRegistry.hpp index d0c68c8fc5b..04d1cea4f6c 100644 --- a/src/cpp/fastdds/xtypes/type_representation/TypeObjectRegistry.hpp +++ b/src/cpp/fastdds/xtypes/type_representation/TypeObjectRegistry.hpp @@ -193,7 +193,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * @brief Get the type dependencies of the given direct hash type identifiers. * * @param[in] type_identifiers Sequence with the queried direct hash TypeIdentifiers. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any given TypeIdentifier is unknown to the registry. * RETCODE_BAD_PARAMETER if any given TypeIdentifier is not a direct hash. @@ -281,7 +281,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * @brief Get the type dependencies of the given TypeObject. * * @param[in] type_object TypeObject queried for its dependencies. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. * RETCODE_BAD_PARAMETER if any given TypeIdentifier is not a direct hash. @@ -313,7 +313,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * @brief Get the type dependencies of the given type identifiers. * * @param[in] type_identifiers Sequence with the queried TypeIdentifiers. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any given TypeIdentifier is unknown to the registry. * RETCODE_BAD_PARAMETER if any given TypeIdentifier is fully descriptive. @@ -326,7 +326,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * @brief Add type dependency to the sequence. * * @param[in] type_id TypeIdentifier to be added. - * @param[in out] type_dependencies TypeIdentfierWithSize sequence. + * @param[in,out] type_dependencies TypeIdentfierWithSize sequence. */ void add_dependency( const TypeIdentifier& type_id, @@ -336,7 +336,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * @brief Get the type dependencies of custom annotations. * * @param[in] custom_annotation_seq Sequence of custom annotations. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. */ @@ -349,7 +349,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either PlainSequenceSElemDefn, PlainSequenceLElemDefn, PlainArraySElemDefn or PlainArrayLElemDefn. * @param[in] collection_type Plain collection Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. * RETCODE_BAD_PARAMETER if the collection type is fully descriptive. @@ -384,7 +384,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either PlainMapSTypeDefn or PlainMapLTypeDefn. * @param[in] map_type Plain map Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. * RETCODE_BAD_PARAMETER if both the key and the elements types are fully descriptive. @@ -425,7 +425,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either a CompleteAliasType or MinimalAliasType. * @param[in] alias_type Alias Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. */ @@ -459,7 +459,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either a CompleteAnnotationType or MinimalAnnotationType. * @param[in] annotation_type Annotation Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. */ @@ -492,7 +492,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either a CompleteStructType or MinimalStructType. * @param[in] struct_type Structure Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. */ @@ -533,7 +533,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either a CompleteUnionType or MinimalUnionType. * @param[in] union_type Union Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. */ @@ -576,7 +576,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either a CompleteSequenceType/MinimalSequenceType/CompleteArrayType/MinimalArrayType. * @param[in] collection_type Sequence or Array Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. */ @@ -610,7 +610,7 @@ class TypeObjectRegistry : public ITypeObjectRegistry * * @tparam T Either a CompleteMapType or MinimalmapType. * @param[in] map_type Map Type. - * @param[in out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. + * @param[in,out] type_dependencies Unordered set of TypeIdentifiers with related TypeObject serialized size. * @return ReturnCode_t RETCODE_OK if the operation is successful. * RETCODE_NO_DATA if any dependent TypeIdentifier is unknown to the registry. */