[rtems commit] sparc/leon3: Add doxygen.

Gedare Bloom gedare at rtems.org
Mon Dec 2 00:23:04 UTC 2013


Module:    rtems
Branch:    master
Commit:    d230d8eaae24d3f705b49790098509f214ef6c5e
Changeset: http://git.rtems.org/rtems/commit/?id=d230d8eaae24d3f705b49790098509f214ef6c5e

Author:    Radu Toma <radustoma at yahoo.com>
Date:      Sat Nov 30 14:51:35 2013 -0600

sparc/leon3: Add doxygen.

---

 c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c   |    8 ++++++--
 c/src/lib/libbsp/sparc/leon3/include/bsp.h         |    4 ++++
 .../sparc/leon3/leon_open_eth/leon_open_eth.c      |   11 +++++++----
 c/src/lib/libbsp/sparc/leon3/smp/getcpuid.c        |    6 +++---
 c/src/lib/libbsp/sparc/leon3/smp/smp_leon3.c       |    6 +++---
 .../lib/libbsp/sparc/leon3/startup/bsppredriver.c  |    9 +++++++--
 c/src/lib/libbsp/sparc/leon3/startup/setvec.c      |   15 ++++++++++-----
 7 files changed, 40 insertions(+), 19 deletions(-)

diff --git a/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c b/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c
index 4fe9320..4b1056f 100644
--- a/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c
+++ b/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c
@@ -1,6 +1,10 @@
+/**
+ * @file
+ * @ingroup sparc_leon3
+ * @brief Support for gnat/rtems interrupts and exception handling
+ */
+
 /*
- *
- * Support for gnat/rtems interrupts and exception handling.
  * Jiri Gaisler, ESA/ESTEC, 17-02-1999.
  */
 
diff --git a/c/src/lib/libbsp/sparc/leon3/include/bsp.h b/c/src/lib/libbsp/sparc/leon3/include/bsp.h
index ecac2d4..4f4c22b 100644
--- a/c/src/lib/libbsp/sparc/leon3/include/bsp.h
+++ b/c/src/lib/libbsp/sparc/leon3/include/bsp.h
@@ -1,3 +1,7 @@
+/**
+ * @defgroup sparc_leon3 Sparc Leon3 Handler
+ */
+
 /*  bsp.h
  *
  *  This include file contains all SPARC simulator definitions.
diff --git a/c/src/lib/libbsp/sparc/leon3/leon_open_eth/leon_open_eth.c b/c/src/lib/libbsp/sparc/leon3/leon_open_eth/leon_open_eth.c
index f8e700c..fe79865 100644
--- a/c/src/lib/libbsp/sparc/leon3/leon_open_eth/leon_open_eth.c
+++ b/c/src/lib/libbsp/sparc/leon3/leon_open_eth/leon_open_eth.c
@@ -1,7 +1,10 @@
-/*
- *  LEON3 Opencores Ethernet MAC Configuration Information
- *
- *  COPYRIGHT (c) 2004.
+/**
+ * @file
+ * @ingroup sparc_leon3
+ * @brief LEON3 Opencores Ethernet MAC Configuration Information
+ */
+
+/*  COPYRIGHT (c) 2004.
  *  Gaisler Research
  *
  *  The license and distribution terms for this file may be
diff --git a/c/src/lib/libbsp/sparc/leon3/smp/getcpuid.c b/c/src/lib/libbsp/sparc/leon3/smp/getcpuid.c
index 824278d..099a83b 100644
--- a/c/src/lib/libbsp/sparc/leon3/smp/getcpuid.c
+++ b/c/src/lib/libbsp/sparc/leon3/smp/getcpuid.c
@@ -1,7 +1,7 @@
 /**
- *  @file
- *
- *  LEON3 SMP Obtain CPU Core Number
+ * @file
+ * @ingroup sparc_leon3
+ * @brief LEON3 SMP Obtain CPU Core Number
  */
 
 /*
diff --git a/c/src/lib/libbsp/sparc/leon3/smp/smp_leon3.c b/c/src/lib/libbsp/sparc/leon3/smp/smp_leon3.c
index 262116f..07c6d24 100644
--- a/c/src/lib/libbsp/sparc/leon3/smp/smp_leon3.c
+++ b/c/src/lib/libbsp/sparc/leon3/smp/smp_leon3.c
@@ -1,7 +1,7 @@
 /**
- *  @file
- *
- *  LEON3 SMP BSP Support
+ * @file
+ * @ingroup sparc_leon3
+ * @brief LEON3 SMP BSP Support
  */
 
 /*
diff --git a/c/src/lib/libbsp/sparc/leon3/startup/bsppredriver.c b/c/src/lib/libbsp/sparc/leon3/startup/bsppredriver.c
index b6788bc..b395b17 100644
--- a/c/src/lib/libbsp/sparc/leon3/startup/bsppredriver.c
+++ b/c/src/lib/libbsp/sparc/leon3/startup/bsppredriver.c
@@ -1,5 +1,10 @@
-/*  Installs the BSP pre-driver hook
- *
+/**
+ * @file
+ * @ingroup sparc_leon3
+ * @brief Installs the BSP pre-driver hook
+ */
+
+/*
  *  COPYRIGHT (c) 2011
  *  Aeroflex Gaisler
  *
diff --git a/c/src/lib/libbsp/sparc/leon3/startup/setvec.c b/c/src/lib/libbsp/sparc/leon3/startup/setvec.c
index d5f69ee..f920189 100644
--- a/c/src/lib/libbsp/sparc/leon3/startup/setvec.c
+++ b/c/src/lib/libbsp/sparc/leon3/startup/setvec.c
@@ -1,6 +1,10 @@
-/*  set_vector
- *
- *  This routine installs an interrupt vector on the SPARC simulator.
+/**  
+ * @file
+ * @ingroup sparc_leon3
+ * @brief Install an interrupt vector on SPARC
+ */
+
+/*  This routine installs an interrupt vector on the SPARC simulator.
  *
  *  INPUT PARAMETERS:
  *    handler - interrupt handler entry point
@@ -12,8 +16,9 @@
  *
  *  RETURNS:
  *    address of previous interrupt handler
- *
- *  COPYRIGHT (c) 1989-1998.
+ */ 
+
+/*  COPYRIGHT (c) 1989-1998.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be




More information about the vc mailing list