Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[21144] Fix Doxygen errors for Doxygen versions prior to 1.8.19 #4896

Merged
merged 1 commit into from
Jun 5, 2024
Merged

[21144] Fix Doxygen errors for Doxygen versions prior to 1.8.19 #4896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions include/fastdds/dds/xtypes/type_representation/TypeObjectUtils.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<typename element>
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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(
Expand All @@ -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.
Expand All @@ -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(
Expand Down
26 changes: 13 additions & 13 deletions src/cpp/fastdds/xtypes/type_representation/TypeObjectRegistry.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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,
Expand All @@ -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.
*/
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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.
*/
Expand Down