host/hs_log: Amend doxygen comments in the header file

Adds missing macro documentation (BLE_NPL_LOG_MODULE). Adds minor formatting improvements.
apache · Feb 14, 2024 · ae9273d · ae9273d
1 parent 33d069e
commit ae9273d
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/nimble/host/include/host/ble_hs_log.h b/nimble/host/include/host/ble_hs_log.h
@@ -20,12 +20,6 @@
 #ifndef H_BLE_HS_LOG_
 #define H_BLE_HS_LOG_
 
-#ifndef BLE_NPL_LOG_MODULE
-#define BLE_NPL_LOG_MODULE BLE_HS_LOG
-#endif
-
-#include <nimble/nimble_npl_log.h>
-
 /**
  * @file ble_hs_log.h
  *
@@ -39,6 +33,13 @@
  * @{
  */
 
+#ifndef BLE_NPL_LOG_MODULE
+/** Defines the logging module for NimBLE Porting Layer (NPL). */
+#define BLE_NPL_LOG_MODULE BLE_HS_LOG
+#endif
+
+#include <nimble/nimble_npl_log.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -103,4 +104,4 @@ void ble_hs_log_flat_buf(const void *data, int len);
  * @}
  */
 
-#endif
+#endif /* H_BLE_HS_LOG_*/