[PATCH 3/8] bsps/sparc: Add files to Doxygen groups

[Sebastian Huber]

From: Frank Kühndel <frank.kuehndel at embedded-brains.de>

Update #3707.
---
 bsps/sparc/include/bsp/gnatcommon.h        | 15 +++++++++++++++
 bsps/sparc/include/bsp/gr_leon4_n2x.h      | 10 +++++++++-
 bsps/sparc/include/drvmgr/leon2_amba_bus.h | 10 +++++++++-
 bsps/sparc/leon3/clock/ckinit.c            | 13 +++++++------
 bsps/sparc/leon3/console/printk_support.c  | 11 ++++++++---
 bsps/sparc/leon3/start/bspstart.c          | 14 +++++++++-----
 bsps/sparc/leon3/start/cache.c             |  8 ++++++++
 bsps/sparc/leon3/start/cpucounter.c        |  8 ++++++++
 bsps/sparc/leon3/start/eirq.c              | 11 +++++++++--
 bsps/sparc/shared/irq/bsp_isr_handler.c    |  9 +++++++++
 10 files changed, 91 insertions(+), 18 deletions(-)

diff --git a/bsps/sparc/include/bsp/gnatcommon.h b/bsps/sparc/include/bsp/gnatcommon.h
index 1a04449293..40e8829bb9 100644
--- a/bsps/sparc/include/bsp/gnatcommon.h
+++ b/bsps/sparc/include/bsp/gnatcommon.h
@@ -1,3 +1,18 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplGnat
+ *
+ * @brief This header file provides interfaces of the
+ *   gnat/rtems interrupts and exception handling.
+ */
+
+/**
+ * @defgroup RTEMSImplGnat GNAT/RTEMS interrupts and exception handling
+ *
+ * @ingroup RTEMSImpl
+ */
+
 #ifndef __GNATCOMMON_H
 #define __GNATCOMMON_H
 
diff --git a/bsps/sparc/include/bsp/gr_leon4_n2x.h b/bsps/sparc/include/bsp/gr_leon4_n2x.h
index 79ea53f953..97ca6d5dfb 100644
--- a/bsps/sparc/include/bsp/gr_leon4_n2x.h
+++ b/bsps/sparc/include/bsp/gr_leon4_n2x.h
@@ -1,7 +1,15 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
-/*  GR-CPCI-LEON4-N2X (NGFP) PCI Peripheral driver
+/**
+ * @file
  *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This header file provides interfaces of the
+ *   GR-CPCI-LEON4-N2X (NGFP) PCI Peripheral driver.
+ */
+
+/*
  *  COPYRIGHT (c) 2013.
  *  Cobham Gaisler AB.
  *
diff --git a/bsps/sparc/include/drvmgr/leon2_amba_bus.h b/bsps/sparc/include/drvmgr/leon2_amba_bus.h
index 93e05442af..0dea2a9426 100644
--- a/bsps/sparc/include/drvmgr/leon2_amba_bus.h
+++ b/bsps/sparc/include/drvmgr/leon2_amba_bus.h
@@ -1,7 +1,15 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
-/*  LEON2 Hardcoded bus driver interface.
+/**
+ * @file
  *
+ * @ingroup RTEMSBSPsSPARCLEON2
+ *
+ * @brief This header file provides interfaces of the
+ *   LEON2 Hardcoded bus driver.
+ */
+
+/*
  *  COPYRIGHT (c) 2008.
  *  Cobham Gaisler AB.
  *
diff --git a/bsps/sparc/leon3/clock/ckinit.c b/bsps/sparc/leon3/clock/ckinit.c
index 60ef5d3ab6..c335652a56 100644
--- a/bsps/sparc/leon3/clock/ckinit.c
+++ b/bsps/sparc/leon3/clock/ckinit.c
@@ -1,13 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
-/*
- *  Clock Tick Device Driver
- *
- *  This routine initializes LEON timer 1 which used for the clock tick.
+/**
+ * @file
  *
- *  The tick frequency is directly programmed to the configured number of
- *  microseconds per tick.
+ * @ingroup RTEMSBSPsSPARCLEON3
  *
+ * @brief This source file contains the Clock Driver implementation.
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2006.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/bsps/sparc/leon3/console/printk_support.c b/bsps/sparc/leon3/console/printk_support.c
index 9e260d2eac..fd23a5033f 100644
--- a/bsps/sparc/leon3/console/printk_support.c
+++ b/bsps/sparc/leon3/console/printk_support.c
@@ -1,10 +1,15 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
-/*
- *  This file contains the TTY driver for the serial ports on the LEON.
+/**
+ * @file
  *
- *  This driver uses the termios pseudo driver.
+ * @ingroup RTEMSBSPsSPARCLEON3
  *
+ * @brief This source file contains the definition of ::BSP_output_char and
+ *   ::BSP_poll_char.
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/bsps/sparc/leon3/start/bspstart.c b/bsps/sparc/leon3/start/bspstart.c
index dec92320e1..2c3844f78d 100644
--- a/bsps/sparc/leon3/start/bspstart.c
+++ b/bsps/sparc/leon3/start/bspstart.c
@@ -1,11 +1,15 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
-/*
- *  This set of routines starts the application.  It includes application,
- *  board, and monitor specific initialization and configuration.
- *  The generic CPU dependent initialization has been performed
- *  before any of these are invoked.
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
  *
+ * @brief This source file contains the implementation of bsp_start() and
+ *   definitions of BSP-specific objects.
+ */
+
+/*
  *  COPYRIGHT (c) 2011
  *  Aeroflex Gaisler
  *
diff --git a/bsps/sparc/leon3/start/cache.c b/bsps/sparc/leon3/start/cache.c
index 5049b7f81c..11af2f4d01 100644
--- a/bsps/sparc/leon3/start/cache.c
+++ b/bsps/sparc/leon3/start/cache.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains the implementation of the Cache Manager.
+ */
+
 /*
  * Copyright (c) 2014 embedded brains GmbH & Co. KG
  *
diff --git a/bsps/sparc/leon3/start/cpucounter.c b/bsps/sparc/leon3/start/cpucounter.c
index 6af91f75e5..c36e7ea23b 100644
--- a/bsps/sparc/leon3/start/cpucounter.c
+++ b/bsps/sparc/leon3/start/cpucounter.c
@@ -1,5 +1,13 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains the implementation of the CPU Counter.
+ */
+
 /*
  * Copyright (C) 2014, 2018 embedded brains GmbH & Co. KG
  *
diff --git a/bsps/sparc/leon3/start/eirq.c b/bsps/sparc/leon3/start/eirq.c
index 05e6789f69..78a1baef25 100644
--- a/bsps/sparc/leon3/start/eirq.c
+++ b/bsps/sparc/leon3/start/eirq.c
@@ -1,8 +1,15 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
-/*
- *  GRLIB/LEON3 extended interrupt controller
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
  *
+ * @brief This source file contains the implementation of the interrupt
+ *   controller support.
+ */
+
+/*
  *  Copyright (C) 2021 embedded brains GmbH & Co. KG
  *
  *  COPYRIGHT (c) 2011
diff --git a/bsps/sparc/shared/irq/bsp_isr_handler.c b/bsps/sparc/shared/irq/bsp_isr_handler.c
index 54e82b15a4..4cd5c7be17 100644
--- a/bsps/sparc/shared/irq/bsp_isr_handler.c
+++ b/bsps/sparc/shared/irq/bsp_isr_handler.c
@@ -1,5 +1,14 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsSPARCLEON3
+ *
+ * @brief This source file contains the implementation of
+ *   _SPARC_Interrupt_dispatch().
+ */
+
 /*
  *  COPYRIGHT (c) 2015
  *  Cobham Gaisler
-- 
2.35.3