From 1d325e7b4da574d793b49beea8833478cef52d42 Mon Sep 17 00:00:00 2001 From: Toma Radu Date: Fri, 6 Dec 2013 02:52:26 -0600 Subject: 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 | 10 +++++++-- c/src/lib/libbsp/sparc/shared/include/ambapp_ids.h | 9 ++++++-- c/src/lib/libbsp/sparc/shared/include/apbuart.h | 10 +++++++-- .../lib/libbsp/sparc/shared/include/apbuart_pci.h | 8 +++++-- .../libbsp/sparc/shared/include/apbuart_rasta.h | 8 +++++-- c/src/lib/libbsp/sparc/shared/include/b1553brm.h | 12 +++++++--- .../lib/libbsp/sparc/shared/include/b1553brm_pci.h | 10 ++++++--- .../libbsp/sparc/shared/include/b1553brm_rasta.h | 10 ++++++--- c/src/lib/libbsp/sparc/shared/include/debug_defs.h | 8 +++++++ c/src/lib/libbsp/sparc/shared/include/grcan.h | 10 +++++++-- .../lib/libbsp/sparc/shared/include/grcan_rasta.h | 6 +++++ c/src/lib/libbsp/sparc/shared/include/grlib.h | 8 +++++-- c/src/lib/libbsp/sparc/shared/include/grspw.h | 10 +++++++-- c/src/lib/libbsp/sparc/shared/include/grspw_pci.h | 26 +++++++++++++--------- .../lib/libbsp/sparc/shared/include/grspw_rasta.h | 10 ++++++--- c/src/lib/libbsp/sparc/shared/include/i2cmst.h | 12 +++++++--- c/src/lib/libbsp/sparc/shared/include/occan.h | 9 ++++++-- c/src/lib/libbsp/sparc/shared/include/occan_pci.h | 10 ++++++--- c/src/lib/libbsp/sparc/shared/include/pci.h | 10 +++++++-- 19 files changed, 147 insertions(+), 49 deletions(-) diff --git a/c/src/lib/libbsp/sparc/shared/include/ambapp.h b/c/src/lib/libbsp/sparc/shared/include/ambapp.h index 1407c639b8..c262087da4 100644 --- a/c/src/lib/libbsp/sparc/shared/include/ambapp.h +++ b/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. * diff --git a/c/src/lib/libbsp/sparc/shared/include/ambapp_ids.h b/c/src/lib/libbsp/sparc/shared/include/ambapp_ids.h index e6f3601ee2..f3271fd87e 100644 --- a/c/src/lib/libbsp/sparc/shared/include/ambapp_ids.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/apbuart.h b/c/src/lib/libbsp/sparc/shared/include/apbuart.h index c948b24da1..e43fb2496d 100644 --- a/c/src/lib/libbsp/sparc/shared/include/apbuart.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/apbuart_pci.h b/c/src/lib/libbsp/sparc/shared/include/apbuart_pci.h index 11ac33e506..e9f75c6314 100644 --- a/c/src/lib/libbsp/sparc/shared/include/apbuart_pci.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/apbuart_rasta.h b/c/src/lib/libbsp/sparc/shared/include/apbuart_rasta.h index 61c6144818..fe73b2e2a7 100644 --- a/c/src/lib/libbsp/sparc/shared/include/apbuart_rasta.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/b1553brm.h b/c/src/lib/libbsp/sparc/shared/include/b1553brm.h index f0f09c5969..ac0e801d35 100644 --- a/c/src/lib/libbsp/sparc/shared/include/b1553brm.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/b1553brm_pci.h b/c/src/lib/libbsp/sparc/shared/include/b1553brm_pci.h index 9861dc3658..22b4d78385 100644 --- a/c/src/lib/libbsp/sparc/shared/include/b1553brm_pci.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/b1553brm_rasta.h b/c/src/lib/libbsp/sparc/shared/include/b1553brm_rasta.h index 360b72fc18..723dc37081 100644 --- a/c/src/lib/libbsp/sparc/shared/include/b1553brm_rasta.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/debug_defs.h b/c/src/lib/libbsp/sparc/shared/include/debug_defs.h index fd71e7ad7c..58f7460f52 100644 --- a/c/src/lib/libbsp/sparc/shared/include/debug_defs.h +++ b/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__ diff --git a/c/src/lib/libbsp/sparc/shared/include/grcan.h b/c/src/lib/libbsp/sparc/shared/include/grcan.h index f8f577d4d5..1918d092a0 100644 --- a/c/src/lib/libbsp/sparc/shared/include/grcan.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/grcan_rasta.h b/c/src/lib/libbsp/sparc/shared/include/grcan_rasta.h index 193cb3683c..dd5ef9518d 100644 --- a/c/src/lib/libbsp/sparc/shared/include/grcan_rasta.h +++ b/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__ diff --git a/c/src/lib/libbsp/sparc/shared/include/grlib.h b/c/src/lib/libbsp/sparc/shared/include/grlib.h index 7f1f7d0667..9c45038d3a 100644 --- a/c/src/lib/libbsp/sparc/shared/include/grlib.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/grspw.h b/c/src/lib/libbsp/sparc/shared/include/grspw.h index e60aa87a07..f530ff34f6 100644 --- a/c/src/lib/libbsp/sparc/shared/include/grspw.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/grspw_pci.h b/c/src/lib/libbsp/sparc/shared/include/grspw_pci.h index 9e2cd60d4a..34b4d365c8 100644 --- a/c/src/lib/libbsp/sparc/shared/include/grspw_pci.h +++ b/c/src/lib/libbsp/sparc/shared/include/grspw_pci.h @@ -1,14 +1,18 @@ - /* - * Macros used for GRSPW controller - * - * COPYRIGHT (c) 2006. - * 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. - * - */ +/** + * @file + * @ingroup spw + * @brief Macros used for GRSPW controller via PCI + */ + +/* + * COPYRIGHT (c) 2006. + * 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__ diff --git a/c/src/lib/libbsp/sparc/shared/include/grspw_rasta.h b/c/src/lib/libbsp/sparc/shared/include/grspw_rasta.h index c4c0cd0dd7..4b76d0bb88 100644 --- a/c/src/lib/libbsp/sparc/shared/include/grspw_rasta.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/i2cmst.h b/c/src/lib/libbsp/sparc/shared/include/i2cmst.h index 9f612fab1e..064582a5cd 100644 --- a/c/src/lib/libbsp/sparc/shared/include/i2cmst.h +++ b/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 diff --git a/c/src/lib/libbsp/sparc/shared/include/occan.h b/c/src/lib/libbsp/sparc/shared/include/occan.h index 5c875b324e..e68cf9506b 100644 --- a/c/src/lib/libbsp/sparc/shared/include/occan.h +++ b/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. * diff --git a/c/src/lib/libbsp/sparc/shared/include/occan_pci.h b/c/src/lib/libbsp/sparc/shared/include/occan_pci.h index d351f85ff9..21889c8cfe 100644 --- a/c/src/lib/libbsp/sparc/shared/include/occan_pci.h +++ b/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 * diff --git a/c/src/lib/libbsp/sparc/shared/include/pci.h b/c/src/lib/libbsp/sparc/shared/include/pci.h index 1bdb7e6c30..bb7afd2d4d 100644 --- a/c/src/lib/libbsp/sparc/shared/include/pci.h +++ b/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 * -- cgit v1.2.3