From 6efbf0c7b8be7add567c391ed1539b046387db90 Mon Sep 17 00:00:00 2001
From: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date: Fri, 30 Aug 2024 09:29:00 +0200
Subject: [PATCH] dev/serial: Rework Zynq UART Doxygen groups

---
 bsps/include/dev/serial/zynq-uart-regs.h     | 15 ++++++++++-----
 bsps/include/dev/serial/zynq-uart-zynq.h     |  4 ++--
 bsps/include/dev/serial/zynq-uart-zynqmp.h   |  4 ++--
 bsps/include/dev/serial/zynq-uart.h          | 17 +++++++++--------
 bsps/shared/dev/serial/zynq-uart-kernel-io.c |  2 +-
 bsps/shared/dev/serial/zynq-uart-polled.c    |  2 +-
 6 files changed, 25 insertions(+), 19 deletions(-)

diff --git a/bsps/include/dev/serial/zynq-uart-regs.h b/bsps/include/dev/serial/zynq-uart-regs.h
index 5e872d16c3..e5810749ab 100644
--- a/bsps/include/dev/serial/zynq-uart-regs.h
+++ b/bsps/include/dev/serial/zynq-uart-regs.h
@@ -1,7 +1,9 @@
 /**
  * @file
- * @ingroup zynq_uart_regs
- * @brief UART register definitions.
+ *
+ * @ingroup RTEMSDeviceSerialZynq
+ *
+ * @brief This header file provides Zynq UART interfaces.
  */
 
 /*
@@ -32,9 +34,12 @@
  */
 
 /**
- * @defgroup zynq_uart_regs UART Register Definitions
- * @ingroup zynq_uart
- * @brief UART Register Definitions
+ * @defgroup RTEMSDeviceSerialZynq Zynq UART Support
+ *
+ * @ingroup RTEMSDeviceConsole
+ *
+ * @brief This group contains the Zynq UART support.
+ *
  * @{
  */
 
diff --git a/bsps/include/dev/serial/zynq-uart-zynq.h b/bsps/include/dev/serial/zynq-uart-zynq.h
index 169037b33a..12895b80ad 100644
--- a/bsps/include/dev/serial/zynq-uart-zynq.h
+++ b/bsps/include/dev/serial/zynq-uart-zynq.h
@@ -3,7 +3,7 @@
 /**
  * @file
  *
- * @ingroup zynq_uart
+ * @ingroup RTEMSDeviceSerialZynq
  *
  * @brief This header file provides interfaces with respect to the Zynq
  *   platform.
@@ -42,7 +42,7 @@ extern "C" {
 #endif /* __cplusplus */
 
 /**
- * @addtogroup zynq_uart
+ * @addtogroup RTEMSDeviceSerialZynq
  *
  * @{
  */
diff --git a/bsps/include/dev/serial/zynq-uart-zynqmp.h b/bsps/include/dev/serial/zynq-uart-zynqmp.h
index 9f29003053..0918e1ca65 100644
--- a/bsps/include/dev/serial/zynq-uart-zynqmp.h
+++ b/bsps/include/dev/serial/zynq-uart-zynqmp.h
@@ -3,7 +3,7 @@
 /**
  * @file
  *
- * @ingroup zynq_uart
+ * @ingroup RTEMSDeviceSerialZynq
  *
  * @brief This header file provides interfaces with respect to the Zynq
  *   UltraScale+ MPSoC and RFSoC platforms.
@@ -42,7 +42,7 @@ extern "C" {
 #endif /* __cplusplus */
 
 /**
- * @addtogroup zynq_uart
+ * @addtogroup RTEMSDeviceSerialZynq
  *
  * @{
  */
diff --git a/bsps/include/dev/serial/zynq-uart.h b/bsps/include/dev/serial/zynq-uart.h
index 002adcdbd6..3a1eff8eff 100644
--- a/bsps/include/dev/serial/zynq-uart.h
+++ b/bsps/include/dev/serial/zynq-uart.h
@@ -1,13 +1,15 @@
 /**
  * @file
- * @ingroup zynq_uart
- * @brief UART support.
+ *
+ * @ingroup RTEMSDeviceSerialZynq
+ *
+ * @brief This header file provides Zynq UART Termios driver interfaces.
  */
 
 /*
  * SPDX-License-Identifier: BSD-2-Clause
  *
- * Copyright (C) 2013, XXX embedded brains GmbH & Co. KG
+ * Copyright (C) 2013, 2024 embedded brains GmbH & Co. KG
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -41,12 +43,9 @@ extern "C" {
 #endif /* __cplusplus */
 
 /**
- * @defgroup zynq_uart UART Support
- * @ingroup RTEMSBSPsARMZynq
- * @brief UART Support
+ * @addtogroup RTEMSDeviceSerialZynq
  *
- * This driver operates an instance of the Cadence UART present in the
- * family of Xilinx Zynq SoCs.
+ * @{
  */
 
 typedef struct {
@@ -59,6 +58,8 @@ typedef struct {
 
 extern const rtems_termios_device_handler zynq_uart_handler;
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */
diff --git a/bsps/shared/dev/serial/zynq-uart-kernel-io.c b/bsps/shared/dev/serial/zynq-uart-kernel-io.c
index 61b1043cd2..7b064167b3 100644
--- a/bsps/shared/dev/serial/zynq-uart-kernel-io.c
+++ b/bsps/shared/dev/serial/zynq-uart-kernel-io.c
@@ -3,7 +3,7 @@
 /**
  * @file
  *
- * @ingroup zynq_uart
+ * @ingroup RTEMSDeviceSerialZynq
  *
  * @brief This source file contains the definition of ::BSP_output_char and
  *   ::BSP_poll_char.
diff --git a/bsps/shared/dev/serial/zynq-uart-polled.c b/bsps/shared/dev/serial/zynq-uart-polled.c
index 34cbc62d8f..979f33282a 100644
--- a/bsps/shared/dev/serial/zynq-uart-polled.c
+++ b/bsps/shared/dev/serial/zynq-uart-polled.c
@@ -3,7 +3,7 @@
 /**
  * @file
  *
- * @ingroup RTEMSBSPsARMZynq
+ * @ingroup RTEMSDeviceSerialZynq
  *
  * @brief This source file contains the implementation of the polled Zynq UART
  *   support.