Fix doxygen warning about undocumented param in deleted functions (#4918

) * Refs #20815: Avoid doxygen warning about undocumented param in deleted functions Signed-off-by: eduponz <eduardoponz@eprosima.com> * Refs #20815: Rename some targets to be able to compile with thirdparty Signed-off-by: eduponz <eduardoponz@eprosima.com> --------- Signed-off-by: eduponz <eduardoponz@eprosima.com>
eProsima · Jun 10, 2024 · 6223543 · 6223543
1 parent 7344e31
commit 6223543
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 21 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -466,7 +466,7 @@ if(BUILD_DOCUMENTATION)
     endif()
 
     # Target to create documentation directories
-    add_custom_target(docdirs
+    add_custom_target(fastdds_docdirs
         COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/doc
         COMMENT "Creating documentation directory" VERBATIM)
 
@@ -479,12 +479,12 @@ if(BUILD_DOCUMENTATION)
     # Configure the template doxyfile for or specific project
     configure_file(doxyfile.in ${PROJECT_BINARY_DIR}/doxyfile @ONLY IMMEDIATE)
     # Add custom target to run doxygen when ever the project is build
-    add_custom_target(doxygen
+    add_custom_target(fastdds_doxygen
         COMMAND "${DOXYGEN_EXECUTABLE}" "${PROJECT_BINARY_DIR}/doxyfile"
         SOURCES "${PROJECT_BINARY_DIR}/doxyfile"
         COMMENT "Generating API documentation with doxygen" VERBATIM)
 
-    add_dependencies(doxygen docdirs)
+    add_dependencies(fastdds_doxygen fastdds_docdirs)
 
     ### README html ########################
 
@@ -535,15 +535,15 @@ if(BUILD_DOCUMENTATION)
             COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/readthedocs_custom.cmake
             )
 
-        add_dependencies(readthedocs docdirs)
+        add_dependencies(readthedocs fastdds_docdirs)
     endif()
 
-    add_custom_target(doc ALL
+    add_custom_target(fastdds_docs ALL
         COMMENT "Generated project documentation" VERBATIM)
 
-    add_dependencies(doc doxygen)
+    add_dependencies(fastdds_docs fastdds_doxygen)
     if(NOT CHECK_DOCUMENTATION)
-        add_dependencies(doc readthedocs)
+        add_dependencies(fastdds_docs readthedocs)
     endif()
 endif()
 

diff --git a/include/fastrtps/types/DynamicLoanableSequence.hpp b/include/fastrtps/types/DynamicLoanableSequence.hpp
@@ -91,27 +91,17 @@ class LoanableSequence<fastrtps::types::DynamicData, _NonConstEnabler>
 
     /// Deleted copy constructor for LoanableSequence.
     LoanableSequence(
-            const LoanableSequence& other) = delete;
+            const LoanableSequence&) = delete;
 
     /// Deleted copy assignment operator for LoanableSequence.
     LoanableSequence& operator =(
-            const LoanableSequence& other) = delete;
+            const LoanableSequence&) = delete;
 
-    /**
-     * @brief Move constructor for LoanableSequence.
-     *
-     * @param[in] other The other LoanableSequence to move from.
-     */
+    /// Move constructor for LoanableSequence.
     LoanableSequence(
             LoanableSequence&&) = default;
 
-    /**
-     * @brief Move assignment operator for LoanableSequence.
-     *
-     * @param[in] other The other LoanableSequence to move from.
-     *
-     * @return A reference to this LoanableSequence.
-     */
+    /// Move assignment operator for LoanableSequence.
     LoanableSequence& operator =(
             LoanableSequence&&) = default;