Skip to content

Commit

Permalink
Fix doxygen documentation for swig [13547] (eProsima#2422)
Browse files Browse the repository at this point in the history
* Refs #13380. Fix doxygen documentaiton for swig

Signed-off-by: Ricardo González Moreno <[email protected]>

* Refs #13538. Fix segfault on Swig 4.0.1

Signed-off-by: Ricardo González Moreno <[email protected]>

* Refs #13380. Apply suggestion.

Signed-off-by: Ricardo González Moreno <[email protected]>

* Apply suggestion

Co-authored-by: José Luis Bueno López <[email protected]>

Co-authored-by: José Luis Bueno López <[email protected]>
  • Loading branch information
richiware and JLBuenoLopez authored Jan 25, 2022
1 parent 9ed09a9 commit 94f9ed8
Show file tree
Hide file tree
Showing 24 changed files with 722 additions and 50 deletions.
8 changes: 8 additions & 0 deletions include/fastdds/dds/core/Entity.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ class Entity

/**
* @brief Constructor
*
* @param mask StatusMask (default: all)
*/
RTPS_DllAPI Entity(
Expand All @@ -52,6 +53,7 @@ class Entity

/**
* @brief This operation enables the Entity
*
* @return RETCODE_OK
*/
virtual fastrtps::types::ReturnCode_t enable()
Expand All @@ -70,6 +72,7 @@ class Entity

/**
* @brief Retrieves the set of relevant statuses for the Entity
*
* @return Reference to the StatusMask with the relevant statuses set to 1
*/
RTPS_DllAPI const StatusMask& get_status_mask() const
Expand All @@ -95,6 +98,7 @@ class Entity

/**
* @brief Retrieves the instance handler that represents the Entity
*
* @return Reference to the InstanceHandle
*/
const InstanceHandle_t& get_instance_handle() const
Expand All @@ -104,6 +108,7 @@ class Entity

/**
* @brief Checks if the Entity is enabled
*
* @return true if enabled, false if not
*/
RTPS_DllAPI bool is_enabled() const
Expand All @@ -119,6 +124,7 @@ class Entity

/**
* @brief Allows access to the StatusCondition associated with the Entity
*
* @return Reference to StatusCondition object
*/
RTPS_DllAPI StatusCondition& get_statuscondition()
Expand All @@ -130,6 +136,7 @@ class Entity

/**
* @brief Setter for the Instance Handle
*
* @param handle Instance Handle
*/
RTPS_DllAPI void set_instance_handle(
Expand Down Expand Up @@ -161,6 +168,7 @@ class DomainEntity : public Entity

/**
* @brief Constructor
*
* @param mask StatusMask (default: all)
*/
RTPS_DllAPI DomainEntity(
Expand Down
Loading

0 comments on commit 94f9ed8

Please sign in to comment.