From 580aee21cf26bbfc792c31300715b1cd57fb4a02 Mon Sep 17 00:00:00 2001
From: Daniel Adam <daniel.adam1922@protonmail.com>
Date: Wed, 18 Sep 2024 13:35:27 +0200
Subject: [PATCH] plgd/dps: fix doxygen documentation

---
 include/plgd/plgd_dps.h | 33 +++++++++++++++++++++++++++------
 1 file changed, 27 insertions(+), 6 deletions(-)

diff --git a/include/plgd/plgd_dps.h b/include/plgd/plgd_dps.h
index d53fcd967..257dd31e8 100644
--- a/include/plgd/plgd_dps.h
+++ b/include/plgd/plgd_dps.h
@@ -16,6 +16,14 @@
  *
  ****************************************************************************/
 
+/**
+ * @file plgd_dps.h
+ *
+ * @brief Device provisioning
+ *
+ * @author Daniel Adam
+ */
+
 #ifndef PLGD_DPS_H
 #define PLGD_DPS_H
 
@@ -41,6 +49,14 @@
 #error "OC_STORAGE must be defined"
 #endif
 
+/**
+ * \defgroup dps Device provisioning
+ *
+ * A facitility to securely provision and preconfigure devices.
+ *
+ * @{
+ */
+
 #include "oc_export.h"
 #include "oc_client_state.h"
 #include "oc_cloud.h"
@@ -395,10 +411,12 @@ OC_API
 void plgd_dps_set_configuration_resource(plgd_dps_context_t *ctx, bool create)
   OC_NONNULL();
 
-/**
- * @brief Maximal size of the retry configuration array
- */
-enum { PLGD_DPS_MAX_RETRY_VALUES_SIZE = 8 };
+enum {
+  /**
+   * @brief Maximal size of the retry configuration array
+   */
+  PLGD_DPS_MAX_RETRY_VALUES_SIZE = 8
+};
 
 /**
  * @brief Configure retry counter.
@@ -726,11 +744,12 @@ plgd_dps_dhcp_set_values_from_vendor_encapsulated_options(
  * @param ctx dps context (cannot be NULL)
  * @param endpoint endpoint of the provisioning server (cannot be NULL)
  *
- * @deprecated Use plgd_dps_add_endpoint_address instead.
+ * @deprecated replaced by plgd_dps_add_endpoint_address in v2.2.5.15
  */
 OC_API
 void plgd_dps_set_endpoint(plgd_dps_context_t *ctx, const char *endpoint)
-  OC_NONNULL() OC_DEPRECATED("Use plgd_dps_add_endpoint_address instead.");
+  OC_NONNULL()
+    OC_DEPRECATED("replaced by plgd_dps_add_endpoint_address in v2.2.5.15");
 
 /**
  * @brief Copy the selected endpoint address of the DPS service to output
@@ -856,4 +875,6 @@ const oc_endpoint_address_t *plgd_dps_selected_endpoint_address(
 }
 #endif
 
+/** @} */
+
 #endif /* PLGD_DPS_H */