Add missing doxygen of public API

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Author: juanlofer-eprosima

ddsenabler/include/ddsenabler/CallbackSet.hpp

@@ -28,10 +28,19 @@ namespace ddsenabler {
  */
 struct DdsCallbacks
 {
+    //! Callback for notifying the reception of DDS types
     participants::DdsTypeNotification type_notification{nullptr};
+
+    //! Callback for notifying the reception of DDS topics
     participants::DdsTopicNotification topic_notification{nullptr};
+
+    //! Callback for notifying the reception of DDS data
     participants::DdsDataNotification data_notification{nullptr};
+
+    //! Callback for requesting information of a DDS type
     participants::DdsTypeQuery type_query{nullptr};
+
+    //! Callback for requesting information of a DDS topic
     participants::DdsTopicQuery topic_query{nullptr};
 };
 
@@ -40,7 +49,10 @@ struct DdsCallbacks
  */
 struct CallbackSet
 {
+    //! Callback executed when consuming log messages
     participants::DdsLogFunc log{nullptr};
+
+    //! DDS related callbacks
     DdsCallbacks dds;
 };
 

ddsenabler/include/ddsenabler/dds_enabler_runner.hpp

@@ -32,9 +32,9 @@ namespace ddsenabler {
 /**
  * @brief Create a DDS Enabler instance from a configuration file path.
  *
- * @param configuration_path Path to the configuration file.
- * @param callbacks Set of callbacks to be used by the DDS Enabler.
- * @param enabler Output parameter to hold the created DDS Enabler instance.
+ * @param [in] configuration_path Path to the configuration file.
+ * @param [in] callbacks Set of callbacks to be used by the DDS Enabler.
+ * @param [out] enabler Output parameter to hold the created DDS Enabler instance.
  * @return true if the DDS Enabler was created successfully, false otherwise.
  */
 DDSENABLER_DllAPI
@@ -45,9 +45,9 @@ bool create_dds_enabler(
 /**
  * @brief Create a DDS Enabler instance from a configuration object.
  *
- * @param configuration DDS Enabler configuration object.
- * @param callbacks Set of callbacks to be used by the DDS Enabler.
- * @param enabler Output parameter to hold the created DDS Enabler instance.
+ * @param [in] configuration DDS Enabler configuration object.
+ * @param [in] callbacks Set of callbacks to be used by the DDS Enabler.
+ * @param [out] enabler Output parameter to hold the created DDS Enabler instance.
  * @return true if the DDS Enabler was created successfully, false otherwise.
  */
 DDSENABLER_DllAPI

ddsenabler_participants/include/ddsenabler_participants/CBCallbacks.hpp

@@ -28,6 +28,12 @@ namespace participants {
 
 /**
  * DdsLogFunc - callback executed when consuming log messages
+ *
+ * @param [in] file_name Name of the file where the log was generated
+ * @param [in] line_no Line number in the file where the log was generated
+ * @param [in] func_name Name of the function where the log was generated
+ * @param [in] category Category of the log message
+ * @param [in] msg Log message content
  */
 typedef void (* DdsLogFunc)(
         const char* file_name,
@@ -38,6 +44,12 @@ typedef void (* DdsLogFunc)(
 
 /**
  * DdsTypeNotification - callback for notifying the reception of DDS types
+ *
+ * @param [in] type_name Name of the received type
+ * @param [in] serialized_type Serialized type in IDL format
+ * @param [in] serialized_type_internal Serialized type in internal format
+ * @param [in] serialized_type_internal_size Size of the serialized type in internal format
+ * @param [in] data_placeholder JSON data placeholder
  */
 typedef void (* DdsTypeNotification)(
         const char* type_name,
@@ -48,6 +60,10 @@ typedef void (* DdsTypeNotification)(
 
 /**
  * DdsTopicNotification - callback for notifying the reception of DDS topics
+ *
+ * @param [in] topic_name Name of the received topic
+ * @param [in] type_name Name of the type associated with the topic
+ * @param [in] serialized_qos Serialized Quality of Service (QoS) of the topic
  */
 typedef void (* DdsTopicNotification)(
         const char* topic_name,
@@ -56,28 +72,42 @@ typedef void (* DdsTopicNotification)(
 
 /**
  * DdsDataNotification - callback for notifying the reception of DDS data
+ *
+ * @param [in] topic_name Name of the topic from which the data was received
+ * @param [in] json JSON representation of the data
+ * @param [in] publish_time Time (nanoseconds since epoch) when the data was published
  */
 typedef void (* DdsDataNotification)(
         const char* topic_name,
         const char* json,
         int64_t publish_time);
 
-/**
- * DdsTopicQuery - callback for requesting information (type and QoS) of a DDS topic
- */
-typedef bool (* DdsTopicQuery)(
-        const char* topic_name,
-        std::string& type_name,
-        std::string& serialized_qos);
-
 /**
  * DdsTypeQuery - callback for requesting information (serialized description and size) of a DDS type
+ *
+ * @param [in] type_name Name of the type to query
+ * @param [out] serialized_type_internal Pointer to the serialized type in internal format
+ * @param [out] serialized_type_internal_size Size of the serialized type in internal format
+ * @return \c true if the type was found and the information was retrieved successfully, \c false otherwise
  */
 typedef bool (* DdsTypeQuery)(
         const char* type_name,
         std::unique_ptr<const unsigned char []>& serialized_type_internal,
         uint32_t& serialized_type_internal_size);
 
+/**
+ * DdsTopicQuery - callback for requesting information (type and QoS) of a DDS topic
+ *
+ * @param [in] topic_name Name of the topic to query
+ * @param [out] type_name Name of the type associated with the topic
+ * @param [out] serialized_qos Serialized Quality of Service (QoS) of the topic
+ * @return \c true if the topic was found and the information was retrieved successfully, \c false otherwise
+ */
+typedef bool (* DdsTopicQuery)(
+        const char* topic_name,
+        std::string& type_name,
+        std::string& serialized_qos);
+
 } /* namespace participants */
 } /* namespace ddsenabler */
 } /* namespace eprosima */