(mynewt-nimble) 03/06: nimble/mesh: Fix doxygen warnings in mesh headers

[ja...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sjanc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git

commit 484facf0ea84d59e869e34689a58ea2ba587745b
Author: raiden00pl <ra...@railab.me>
AuthorDate: Wed Oct 14 09:44:30 2026 +0200

    nimble/mesh: Fix doxygen warnings in mesh headers
    
    Document the Configuration Database structures and drop the reference
    to the non-existent kernel_apis group in atomic.h, so the public mesh
    headers pass the doxygen check.
    
    Assisted-by: Claude:claude-fable-5-1
    Signed-off-by: raiden00pl <ra...@railab.me>
---
 nimble/host/mesh/include/mesh/atomic.h |  1 -
 nimble/host/mesh/include/mesh/cdb.h    | 25 +++++++++++++++++++++++--
 2 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/nimble/host/mesh/include/mesh/atomic.h b/nimble/host/mesh/include/mesh/atomic.h
index 2c7317948..6f3c9d6d3 100644
--- a/nimble/host/mesh/include/mesh/atomic.h
+++ b/nimble/host/mesh/include/mesh/atomic.h
@@ -19,7 +19,6 @@ typedef atomic_t atomic_val_t;
 
 /**
  * @defgroup atomic_apis Atomic Services APIs
- * @ingroup kernel_apis
  * @{
  */
 
diff --git a/nimble/host/mesh/include/mesh/cdb.h b/nimble/host/mesh/include/mesh/cdb.h
index fa691eb64..752b3358e 100644
--- a/nimble/host/mesh/include/mesh/cdb.h
+++ b/nimble/host/mesh/include/mesh/cdb.h
@@ -26,33 +26,48 @@ enum {
 	BT_MESH_CDB_NODE_FLAG_COUNT
 };
 
+/** Provisioned node entry. */
 struct bt_mesh_cdb_node {
+	/** Device UUID. */
 	uint8_t  uuid[16];
+	/** Primary element unicast address. */
 	uint16_t addr;
+	/** Network key index. */
 	uint16_t net_idx;
+	/** Number of elements. */
 	uint8_t  num_elem;
+	/** Device key. */
 	uint8_t  dev_key[16];
 
+	/** Node flags. */
 	ATOMIC_DEFINE(flags, BT_MESH_CDB_NODE_FLAG_COUNT);
 };
 
+/** Subnet entry. */
 struct bt_mesh_cdb_subnet {
+	/** Network key index. */
 	uint16_t net_idx;
 
+	/** Key Refresh phase. */
 	uint8_t kr_phase;
 
 	struct {
+		/** Network key. */
 		uint8_t net_key[16];
-	} keys[2];
+	} keys[2]; /**< Current and updated keys. */
 };
 
+/** Application key entry. */
 struct bt_mesh_cdb_app_key {
+	/** Bound network key index. */
 	uint16_t net_idx;
+	/** Application key index. */
 	uint16_t app_idx;
 
 	struct {
+		/** Application key. */
 		uint8_t app_key[16];
-	} keys[2];
+	} keys[2]; /**< Current and updated keys. */
 };
 
 enum {
@@ -65,13 +80,19 @@ enum {
 	BT_MESH_CDB_FLAG_COUNT,
 };
 
+/** Mesh Configuration Database. */
 struct bt_mesh_cdb {
+	/** IV index. */
 	uint32_t iv_index;
 
+	/** Database flags. */
 	ATOMIC_DEFINE(flags, BT_MESH_CDB_FLAG_COUNT);
 
+	/** Provisioned nodes. */
 	struct bt_mesh_cdb_node nodes[NODE_COUNT];
+	/** Subnets. */
 	struct bt_mesh_cdb_subnet subnets[SUBNET_COUNT];
+	/** Application keys. */
 	struct bt_mesh_cdb_app_key app_keys[APP_KEY_COUNT];
 };