Refs #20815: Add doxygen in DynamicLoanableSequence

Signed-off-by: eduponz <eduardoponz@eprosima.com>
eProsima · Jun 5, 2024 · 344c935 · 344c935
1 parent b5db04f
commit 344c935
Showing 1 changed file with 56 additions and 0 deletions.
diff --git a/include/fastrtps/types/DynamicLoanableSequence.hpp b/include/fastrtps/types/DynamicLoanableSequence.hpp
@@ -30,22 +30,40 @@ namespace dds {
 
 /**
  * @brief LoanableSequence specialization for DynamicData.
+ *
+ * This class provides a sequence container for handling loanable collections
+ * of DynamicData.
+ *
+ * @tparam _NonConstEnabler to enable data access through [] operator on non-const sequences.
  */
 template<typename _NonConstEnabler>
 class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
     : public LoanableTypedCollection<fastrtps::types::DynamicData, _NonConstEnabler>
 {
 public:
 
+    /// Type for the size of the sequence.
     using size_type = LoanableCollection::size_type;
+
+    /// Type for the elements in the sequence.
     using element_type = LoanableCollection::element_type;
 
+    /**
+     * @brief Construct a LoanableSequence with a specified dynamic type.
+     *
+     * @param[in] dyn_type Pointer to the DynamicType.
+     */
     LoanableSequence(
             fastrtps::types::DynamicType_ptr dyn_type)
         : dynamic_type_support_(new fastrtps::types::DynamicPubSubType(dyn_type))
     {
     }
 
+    /**
+     * @brief Construct a LoanableSequence with a specified maximum size.
+     *
+     * @param[in] max Maximum size of the sequence.
+     */
     LoanableSequence(
             size_type max)
     {
@@ -57,6 +75,9 @@ class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
         resize(max);
     }
 
+    /**
+     * @brief Destructor for LoanableSequence.
+     */
     ~LoanableSequence()
     {
         if (elements_ && !has_ownership_)
@@ -68,12 +89,24 @@ class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
         release();
     }
 
+    /**
+     * @brief Copy constructor for LoanableSequence.
+     *
+     * @param[in] other The other LoanableSequence to copy from.
+     */
     LoanableSequence(
             const LoanableSequence& other)
     {
         *this = other;
     }
 
+    /**
+     * @brief Copy assignment operator for LoanableSequence.
+     *
+     * @param[in] other The other LoanableSequence to assign from.
+     *
+     * @return A reference to this LoanableSequence.
+     */
     LoanableSequence& operator =(
             const LoanableSequence& other)
     {
@@ -93,9 +126,21 @@ class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
         return *this;
     }
 
+    /**
+     * @brief Move constructor for LoanableSequence.
+     *
+     * @param[in] other The other LoanableSequence to move from.
+     */
     LoanableSequence(
             LoanableSequence&&) = default;
 
+    /**
+     * @brief Move assignment operator for LoanableSequence.
+     *
+     * @param[in] other The other LoanableSequence to move from.
+     *
+     * @return A reference to this LoanableSequence.
+     */
     LoanableSequence& operator =(
             LoanableSequence&&) = default;
 
@@ -108,6 +153,11 @@ class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
 
 private:
 
+    /**
+     * @brief Resize the sequence to a new maximum size.
+     *
+     * @param[in] maximum The new maximum size.
+     */
     void resize(
             size_type maximum) override
     {
@@ -125,6 +175,9 @@ class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
         }
     }
 
+    /**
+     * @brief Release all elements and clear the sequence.
+     */
     void release()
     {
         if (has_ownership_ && elements_)
@@ -143,11 +196,14 @@ class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
         has_ownership_ = true;
     }
 
+    /// Container for holding the DynamicData elements.
     std::vector<fastrtps::types::DynamicData*> data_;
 
+    /// Pointer to the DynamicPubSubType type support.
     std::unique_ptr<fastrtps::types::DynamicPubSubType> dynamic_type_support_;
 };
 
+/// Alias for LoanableSequence with DynamicData and true_type.
 using DynamicLoanableSequence = LoanableSequence<fastrtps::types::DynamicData, std::true_type>;
 
 } // namespace dds