From 03f8145fb2cd496a0e1bcdea9ba0e51f51259128 Mon Sep 17 00:00:00 2001
From: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
Date: Tue, 23 Dec 2025 14:26:48 +0100
Subject: [PATCH] lib: Add missing file headers for doxygen generation

Add file header on missing .c and *h files to display brief
in documentation.

Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
---
 lib/compiler/armcc/errno.h | 5 +++++
 lib/compiler/iar/errno.h   | 5 +++++
 lib/device.c               | 5 +++++
 lib/dma.c                  | 5 +++++
 lib/init.c                 | 5 +++++
 lib/io.c                   | 5 +++++
 lib/irq.c                  | 5 +++++
 lib/log.c                  | 5 +++++
 lib/softirq.c              | 5 +++++
 lib/system/nuttx/io.c      | 5 +++++
 lib/version.c              | 5 +++++
 11 files changed, 55 insertions(+)

diff --git a/lib/compiler/armcc/errno.h b/lib/compiler/armcc/errno.h
index d32d241..9d4d29a 100644
--- a/lib/compiler/armcc/errno.h
+++ b/lib/compiler/armcc/errno.h
@@ -9,6 +9,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	armcc/errno.h
+ * @brief	ARMCC specific error definitions.
+ */
+
 #ifndef __METAL_ARMCC_ERRNO__H__
 #define __METAL_ARMCC_ERRNO__H__
 
diff --git a/lib/compiler/iar/errno.h b/lib/compiler/iar/errno.h
index 69cd86c..a448207 100644
--- a/lib/compiler/iar/errno.h
+++ b/lib/compiler/iar/errno.h
@@ -8,6 +8,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	iar/errno.h
+ * @brief	IAR specific error definitions.
+ */
+
 #ifndef __METAL_IAR_ERRNO__H__
 #define __METAL_IAR_ERRNO__H__
 
diff --git a/lib/device.c b/lib/device.c
index 45e08ec..92265b3 100644
--- a/lib/device.c
+++ b/lib/device.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	device.c
+ * @brief	libmetal bus abstraction definitions.
+ */
+
 #include <string.h>
 #include <metal/assert.h>
 #include <metal/device.h>
diff --git a/lib/dma.c b/lib/dma.c
index 7edaa54..3cb86ec 100644
--- a/lib/dma.c
+++ b/lib/dma.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	dma.c
+ * @brief	Libmetal DMA primitives definitions.
+ */
+
 #include <metal/errno.h>
 #include <string.h>
 #include <metal/device.h>
diff --git a/lib/init.c b/lib/init.c
index 5a6a006..e92444a 100644
--- a/lib/init.c
+++ b/lib/init.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	init.c
+ * @brief	Libmetal initialization.
+ */
+
 #include <string.h>
 #include <metal/sys.h>
 
diff --git a/lib/io.c b/lib/io.c
index 7faf405..7155bac 100644
--- a/lib/io.c
+++ b/lib/io.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	io.c
+ * @brief	Libmetal I/O access primitives definition.
+ */
+
 #include <limits.h>
 #include <metal/errno.h>
 #include <metal/io.h>
diff --git a/lib/irq.c b/lib/irq.c
index c8578fa..eb638db 100644
--- a/lib/irq.c
+++ b/lib/irq.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	irq.c
+ * @brief	Libmetal interrupt primitives definition.
+ */
+
 #include <metal/errno.h>
 #include <metal/irq.h>
 #include <metal/irq_controller.h>
diff --git a/lib/log.c b/lib/log.c
index 22c8b9b..8e98590 100644
--- a/lib/log.c
+++ b/lib/log.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	log.c
+ * @brief	Libmetal Logging primitives definition.
+ */
+
 #include <stdarg.h>
 #include <stdio.h>
 
diff --git a/lib/softirq.c b/lib/softirq.c
index ac481cc..42afcf5 100644
--- a/lib/softirq.c
+++ b/lib/softirq.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	softirq.c
+ * @brief	Libmetal soft interrupt primitives definition.
+ */
+
 #include <metal/atomic.h>
 #include <metal/errno.h>
 #include <metal/irq.h>
diff --git a/lib/system/nuttx/io.c b/lib/system/nuttx/io.c
index 9d4d6d3..58cae21 100644
--- a/lib/system/nuttx/io.c
+++ b/lib/system/nuttx/io.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	nuttx/io.c
+ * @brief	NuttX libmetal io operations
+ */
+
 #include <stddef.h>
 #include <metal/cache.h>
 #include <metal/io.h>
diff --git a/lib/version.c b/lib/version.c
index bc23ee4..c21f7db 100644
--- a/lib/version.c
+++ b/lib/version.c
@@ -4,6 +4,11 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+/**
+ * @file	version.c
+ * @brief	Libmetal version information definition.
+ */
+
 #include <metal/config.h>
 
 int metal_ver_major(void)