sparc BSP shared: Improve Doxygen

Add doxygen to the header files in sparc/shared/include directory.

c/src/lib/libbsp/sparc/shared/include/ambapp.h

@@ -1,6 +1,12 @@
+/**
+ * @file
+ * @ingroup sparc_bsp
+ * @defgroup amba AMBA
+ * @ingroup amba
+ * @brief AMBA Plug &Play routines
+ */
+
 /*
- *  AMBA Plug & Play routines
- *
  *  COPYRIGHT (c) 2009.
  *  Aeroflex Gaisler.
  *

c/src/lib/libbsp/sparc/shared/include/ambapp_ids.h

@@ -1,5 +1,10 @@
-/*  AMBA Plug & Play Bus Vendor and Device IDs.
+/**
- *
+ * @file
+ * @ingroup amba
+ * @brief AMBA Plug & Play Bus Vendor and Device IDs
+ */
+
+/*
  *  COPYRIGHT (c) 2008.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/apbuart.h

@@ -1,6 +1,12 @@
+/**
+ * @file
+ * @ingroup sparc_bsp
+ * @defgroup uart UART
+ * @ingroup uart
+ * @brief Driver interface for APBUART
+ */
+
 /*
- *  Driver interface for APBUART
- *
  *  COPYRIGHT (c) 2007.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/apbuart_pci.h

@@ -1,6 +1,10 @@
+/**
+ * @file
+ * @ingroup uart
+ * @brief APBUART via PCI - driver interface
+ */
+
 /*
- *  APBUART via PCI - driver interface
- *
  *  COPYRIGHT (c) 2007.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/apbuart_rasta.h

@@ -1,6 +1,10 @@
+/**
+ * @file
+ * @ingroup uart
+ * @brief APBUART RASTA via PCI - driver interface
+ */
+
 /*
- *  APBUART RASTA via PCI - driver interface
- *
  *  COPYRIGHT (c) 2007.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/b1553brm.h

@@ -1,6 +1,12 @@
- /*
+/**
- *  Macros used for brm controller
+ * @file
- *
+ * @ingroup sparc_bsp
+ * @defgroup 1553 B1553BRM
+ * @ingroup 1553
+ * @brief Macros used for brm controller
+ */
+
+/*
  *  COPYRIGHT (c) 2006.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/b1553brm_pci.h

@@ -1,6 +1,10 @@
- /*
+/**
- *  Macros used for brm controller
+ * @file
- *
+ * @ingroup 1553
+ * @brief Macros used for brm controller via PCI
+ */
+
+/*
  *  COPYRIGHT (c) 2006.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/b1553brm_rasta.h

@@ -1,6 +1,10 @@
- /*
+/**
- *  Macros used for brm controller
+ * @file
- *
+ * @ingroup 1553
+ * @brief Macros used for brm RASTA controller
+ */
+
+/*
  *  COPYRIGHT (c) 2006.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/debug_defs.h

@@ -1,3 +1,11 @@
+/**
+ * @file
+ * @ingroup bsp_kit
+ * @defgroup sparc_bsp SPARC
+ * @ingroup sparc_bsp
+ * @brief Debug Definitions
+ */
+
 #ifndef __DEBUG_DEFS_H__
 #define __DEBUG_DEFS_H__
 

c/src/lib/libbsp/sparc/shared/include/grcan.h

@@ -1,6 +1,12 @@
+/**
+ * @file
+ * @ingroup sparc_bsp
+ * @defgroup can GRCAN
+ * @ingroup can
+ * @brief Macros used for grcan controller
+ */
+
 /*
- *  Macros used for grcan controller
- *
  *  COPYRIGHT (c) 2007.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/grcan_rasta.h

@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup can
+ * @brief Registers the GRCAN for RASTA
+ */
+
 #ifndef __GRCAN_RASTA_H__
 #define __GRCAN_RASTA_H__
 

c/src/lib/libbsp/sparc/shared/include/grlib.h

@@ -1,6 +1,10 @@
+/**
+ * @file
+ * @ingroup amba
+ * @brief Common GRLIB AMBA Core Register definitions
+ */
+
 /*
- *  Common GRLIB AMBA Core Register definitions
- *
  *  COPYRIGHT (c) 2012
  *  Aeroflex Gaisler
  *

c/src/lib/libbsp/sparc/shared/include/grspw.h

@@ -1,6 +1,12 @@
+/**
+ * @file
+ * @ingroup sparc_bsp
+ * @defgroup spw SpaceWire
+ * @ingroup spw
+ * @brief Macros used for Spacewire bus
+ */
+
 /*
- *  Macros used for Spacewire bus
- *
  *  COPYRIGHT (c) 2007.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/grspw_pci.h

@@ -1,14 +1,18 @@
- /*
+/**
-  *  Macros used for GRSPW controller
+ * @file
-  *
+ * @ingroup spw
-  *  COPYRIGHT (c) 2006.
+ * @brief Macros used for GRSPW controller via PCI
-  *  Gaisler Research
+ */
-  *
+
-  *  The license and distribution terms for this file may be
+/*
-  *  found in the file LICENSE in this distribution or at
+ *  COPYRIGHT (c) 2006.
-  *  http://www.rtems.com/license/LICENSE.
+ *  Gaisler Research
-  *
+ *
-  */
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ *
+ */
 
 #ifndef __GRSPW_PCI_H__
 #define __GRSPW_PCI_H__

c/src/lib/libbsp/sparc/shared/include/grspw_rasta.h

@@ -1,6 +1,10 @@
- /*
+/**
- *  Macros used for RASTA PCI GRSPW controller
+ * @file
- *
+ * @ingroup spw
+ * @brief Macros used for RASTA PCI GRSPW controller
+ */
+
+/*
  *  COPYRIGHT (c) 2006.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/i2cmst.h

@@ -1,6 +1,12 @@
+/**
+ * @file
+ * @ingroup sparc_bsp
+ * @defgroup i2c I2C-master
+ * @ingroup i2c
+ * @brief Driver for GRLIB port of OpenCores I2C-master
+ */
+
 /*
- * Driver for GRLIB port of OpenCores I2C-master
- *
  * COPYRIGHT (c) 2007 Gaisler Research
  * with parts from the RTEMS MPC83xx I2C driver (c) 2007 Embedded Brains GmbH.
  *
@@ -8,8 +14,8 @@
  * found in the file LICENSE in this distribution or at
  * http://www.rtems.com/license/LICENSE.
  *
- * This file contains the driver declarations
  */
+
 #ifndef _I2CMST_H
 #define _I2CMST_H
 

c/src/lib/libbsp/sparc/shared/include/occan.h

@@ -1,5 +1,10 @@
-/*  Gaisler wrapper to OpenCores CAN, driver interface
+/**
- *
+ * @file
+ * @ingroup can
+ * @brief Gaisler wrapper to OpenCores CAN - driver interface
+ */
+
+/*
  *  COPYRIGHT (c) 2007.
  *  Gaisler Research.
  *

c/src/lib/libbsp/sparc/shared/include/occan_pci.h

@@ -1,6 +1,10 @@
- /*
+/**
- *  OC_CAN controller via PCI - driver interface
+ * @file
- *
+ * @ingroup can
+ * @brief OC_CAN controller via PCI - driver interface
+ */
+
+/*
  *  COPYRIGHT (c) 2007.
  *  Gaisler Research
  *

c/src/lib/libbsp/sparc/shared/include/pci.h

@@ -1,6 +1,12 @@
+/**
+ * @file
+ * @ingroup sparc_bsp
+ * @defgroup pci PCI
+ * @ingroup pci
+ * @brief PCI defines and function prototypes
+ */
+
 /*
- *
- *	PCI defines and function prototypes
  *	Copyright 1994, Drew Eckhardt
  *	Copyright 1997, 1998 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
  *