[rtems commit] i386/pc386: Add doxygen file headers.

Jennifer Averett jennifer at rtems.org
Mon Dec 30 16:44:15 UTC 2013 

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

Author:    Toma Radu <radustoma at yahoo.com>
Date:      Mon Dec 30 10:48:57 2013 -0600

i386/pc386: Add doxygen file headers.

---

 c/src/lib/libbsp/i386/pc386/3c509/3c509.h        |   16 ++++++++++++++++
 c/src/lib/libbsp/i386/pc386/3c509/elink.h        |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/console/exar17d15x.h |    7 ++++---
 c/src/lib/libbsp/i386/pc386/console/i386kbd.h    |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/console/kd.h         |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/console/keyboard.h   |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/console/ps2_drv.h    |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/console/ps2_mouse.h  |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/console/rtd316.h     |    7 +++----
 c/src/lib/libbsp/i386/pc386/console/vgacons.h    |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/include/bsp.h        |   16 ++++++++++++++++
 c/src/lib/libbsp/i386/pc386/include/crt.h        |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/include/tm27.h       |    8 ++++++++
 c/src/lib/libbsp/i386/pc386/include/wd80x3.h     |    8 ++++++++
 14 files changed, 119 insertions(+), 7 deletions(-)

diff --git a/c/src/lib/libbsp/i386/pc386/3c509/3c509.h b/c/src/lib/libbsp/i386/pc386/3c509/3c509.h
index f3b8195..9753429 100644
--- a/c/src/lib/libbsp/i386/pc386/3c509/3c509.h
+++ b/c/src/lib/libbsp/i386/pc386/3c509/3c509.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup pc386_3c509
+ *
+ * @brief 3C509 PC card support.
+ */
+
 /*
  * Copyright (c) 1993 Herb Peyerl (hpeyerl at novatel.ca) All rights reserved.
  *
@@ -47,6 +55,14 @@
  *		nao at tom-yam.or.jp
  */
 
+/**
+ * @defgroup pc386_3c509 3C509 Support
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief 3C509 support.
+ */
+
 /*
 typedef unsigned short u_short;
 typedef unsigned long  u_long;
diff --git a/c/src/lib/libbsp/i386/pc386/3c509/elink.h b/c/src/lib/libbsp/i386/pc386/3c509/elink.h
index cf0767e..bcb13a4 100644
--- a/c/src/lib/libbsp/i386/pc386/3c509/elink.h
+++ b/c/src/lib/libbsp/i386/pc386/3c509/elink.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ * 
+ * @ingroup pc386_3c509
+ *
+ * @brief EtherLink definitions.
+ */
+
 /*
  * Copyright (c) 1994 Charles Hannum.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/i386/pc386/console/exar17d15x.h b/c/src/lib/libbsp/i386/pc386/console/exar17d15x.h
index 40922e9..1a0cfbc 100644
--- a/c/src/lib/libbsp/i386/pc386/console/exar17d15x.h
+++ b/c/src/lib/libbsp/i386/pc386/console/exar17d15x.h
@@ -1,8 +1,9 @@
 /**
- * @file bsp/exar17d15x.h
+ * @file
  *
- *  This file provides the interface to the Exar Multiport
- *  PCI UART controller.
+ * @ingroup i386_pc386
+ *
+ * @brief Exar Multiport PCI UART interface.
  */
 
 /*
diff --git a/c/src/lib/libbsp/i386/pc386/console/i386kbd.h b/c/src/lib/libbsp/i386/pc386/console/i386kbd.h
index b6fa0be..627b37c 100644
--- a/c/src/lib/libbsp/i386/pc386/console/i386kbd.h
+++ b/c/src/lib/libbsp/i386/pc386/console/i386kbd.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ * 
+ * @ingroup i386_pc386
+ *
+ * @brief I386 keyboard definitions.
+ */
+
 /*
  *  linux/include/asm-i386/keyboard.h
  *
diff --git a/c/src/lib/libbsp/i386/pc386/console/kd.h b/c/src/lib/libbsp/i386/pc386/console/kd.h
index 6f10295..c97e4f7 100644
--- a/c/src/lib/libbsp/i386/pc386/console/kd.h
+++ b/c/src/lib/libbsp/i386/pc386/console/kd.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief KD definitions.
+ */
+
 /*
  *  by: Rosimildo da Silva:  rdasilva at connecttel.com
  *
diff --git a/c/src/lib/libbsp/i386/pc386/console/keyboard.h b/c/src/lib/libbsp/i386/pc386/console/keyboard.h
index a5ad346..ffc8aab 100644
--- a/c/src/lib/libbsp/i386/pc386/console/keyboard.h
+++ b/c/src/lib/libbsp/i386/pc386/console/keyboard.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief Keyboard definitions.
+ */
+
 /*
  *  Submitted by: Rosimildo da Silva:  rdasilva at connecttel.com
  */
diff --git a/c/src/lib/libbsp/i386/pc386/console/ps2_drv.h b/c/src/lib/libbsp/i386/pc386/console/ps2_drv.h
index 33bcf64..536b56a 100644
--- a/c/src/lib/libbsp/i386/pc386/console/ps2_drv.h
+++ b/c/src/lib/libbsp/i386/pc386/console/ps2_drv.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief Paux driver routines.
+ */
+
 #ifndef __paux_drv__
 #define __paux_drv__
 /***************************************************************************
diff --git a/c/src/lib/libbsp/i386/pc386/console/ps2_mouse.h b/c/src/lib/libbsp/i386/pc386/console/ps2_mouse.h
index adb39c1..dd61e8a 100644
--- a/c/src/lib/libbsp/i386/pc386/console/ps2_mouse.h
+++ b/c/src/lib/libbsp/i386/pc386/console/ps2_mouse.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief Keyboard and mouse definitions.
+ */
+
 /*
  *	include/linux/pc_keyb.h
  *	PC Keyboard And Keyboard Controller
diff --git a/c/src/lib/libbsp/i386/pc386/console/rtd316.h b/c/src/lib/libbsp/i386/pc386/console/rtd316.h
index a88d001..86fd7d9 100644
--- a/c/src/lib/libbsp/i386/pc386/console/rtd316.h
+++ b/c/src/lib/libbsp/i386/pc386/console/rtd316.h
@@ -1,10 +1,9 @@
 /**
- *  @file bsp/rtd316.h
+ * @file
  *
- *  @brief RTD316 Driver Interface Definition
+ * @ingroup i386_pc386
  *
- *  This file provides the interface to the RTD316 Dual
- *  serial port utility module.
+ * @brief RTD316 driver interface defintions.
  */
 
 /*
diff --git a/c/src/lib/libbsp/i386/pc386/console/vgacons.h b/c/src/lib/libbsp/i386/pc386/console/vgacons.h
index 4de6909..4ffc907 100644
--- a/c/src/lib/libbsp/i386/pc386/console/vgacons.h
+++ b/c/src/lib/libbsp/i386/pc386/console/vgacons.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief VGA definitions.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2011.
  *  On-Line Applications Research Corporation (OAR).
diff --git a/c/src/lib/libbsp/i386/pc386/include/bsp.h b/c/src/lib/libbsp/i386/pc386/include/bsp.h
index 625d4ce..89ae4b5 100644
--- a/c/src/lib/libbsp/i386/pc386/include/bsp.h
+++ b/c/src/lib/libbsp/i386/pc386/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief Global BSP definitions.
+ */
+
 /*-------------------------------------------------------------------------+
 | bsp.h v1.1 - PC386 BSP - 1997/08/07
 +--------------------------------------------------------------------------+
@@ -53,6 +61,14 @@ extern "C" {
 #include <libcpu/cpu.h>
 #include <rtems/bspIo.h>
 
+/**
+ * @degroup pc386_i386 PC386 Support
+ *
+ * @ingroup bsp_i386
+ *
+ * @brief PC386 support.
+ */
+
 #define BSP_HAS_FRAME_BUFFER 1
 
 /*
diff --git a/c/src/lib/libbsp/i386/pc386/include/crt.h b/c/src/lib/libbsp/i386/pc386/include/crt.h
index 258fe1a..ac0bf2e 100644
--- a/c/src/lib/libbsp/i386/pc386/include/crt.h
+++ b/c/src/lib/libbsp/i386/pc386/include/crt.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief CRT controller definitions.
+ */
+
 /*
  * crt.h  - This file contains definitions for constants related to PC console.
  *          More information can be found at
diff --git a/c/src/lib/libbsp/i386/pc386/include/tm27.h b/c/src/lib/libbsp/i386/pc386/include/tm27.h
index 2ae7a94..86be5b3 100644
--- a/c/src/lib/libbsp/i386/pc386/include/tm27.h
+++ b/c/src/lib/libbsp/i386/pc386/include/tm27.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief Implementation of interrupt mechanisms for Time Test 27.
+ */
+
 /*
  *  tm27.h
  *
diff --git a/c/src/lib/libbsp/i386/pc386/include/wd80x3.h b/c/src/lib/libbsp/i386/pc386/include/wd80x3.h
index 3a9476a..b4aa12e 100644
--- a/c/src/lib/libbsp/i386/pc386/include/wd80x3.h
+++ b/c/src/lib/libbsp/i386/pc386/include/wd80x3.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup i386_pc386
+ *
+ * @brief DP8390 Ethernet controller definitions.
+ */
+
 /*
  *  Information about the DP8390 Ethernet controller.
  */

More information about the vc mailing list