[rtems commit] Header File Doxygen Enhancement Task #2
Jennifer Averett
jennifer at rtems.org
Fri Dec 28 16:32:28 UTC 2012
Module: rtems
Branch: master
Commit: 9ab091e1e4b5572c0d327722dfbfd9d1bbccd405
Changeset: http://git.rtems.org/rtems/commit/?id=9ab091e1e4b5572c0d327722dfbfd9d1bbccd405
Author: Mathew Kallada <matkallada at gmail.com>
Date: Fri Dec 28 10:35:32 2012 -0600
Header File Doxygen Enhancement Task #2
---
cpukit/include/rtems/bspIo.h | 2 +
cpukit/libblock/include/rtems/bdpart.h | 2 +-
cpukit/libblock/include/rtems/blkdev.h | 2 +-
cpukit/libblock/include/rtems/diskdevs.h | 8 ++--
cpukit/libblock/include/rtems/flashdisk.h | 2 +
cpukit/libcsupport/include/clockdrv.h | 2 +
cpukit/libcsupport/include/timerdrv.h | 4 ++-
cpukit/libcsupport/include/zilog/z8036.h | 2 +
cpukit/libfs/src/pipe/pipe.h | 14 +++++----
cpukit/libfs/src/rfs/rtems-rfs-format.h | 17 ++++++-----
cpukit/libmisc/bspcmdline/bspcmdline.h | 3 ++
cpukit/libmisc/fb/mw_uid.h | 7 +++-
cpukit/libmisc/serdbg/serdbgcnf.h | 6 ++++
cpukit/libmisc/serdbg/termios_printk_cnf.h | 6 ++++
cpukit/libmisc/stackchk/stackchk.h | 10 ++++--
cpukit/libqos/qreslib.h | 7 +++-
cpukit/sapi/include/confdefs.h | 43 +++++++++++++++-------------
cpukit/sapi/include/rtems/cbs.h | 7 +++-
cpukit/sapi/include/rtems/config.h | 2 +
19 files changed, 96 insertions(+), 50 deletions(-)
diff --git a/cpukit/include/rtems/bspIo.h b/cpukit/include/rtems/bspIo.h
index dc5f304..db9ac03 100644
--- a/cpukit/include/rtems/bspIo.h
+++ b/cpukit/include/rtems/bspIo.h
@@ -1,6 +1,8 @@
/**
* @file rtems/bspIo.h
*
+ * @brief Interface to Kernel Print Methods
+ *
* This include file defines the interface to kernel print methods.
*/
diff --git a/cpukit/libblock/include/rtems/bdpart.h b/cpukit/libblock/include/rtems/bdpart.h
index 27daae0..566864d 100644
--- a/cpukit/libblock/include/rtems/bdpart.h
+++ b/cpukit/libblock/include/rtems/bdpart.h
@@ -3,7 +3,7 @@
*
* @ingroup rtems_bdpart
*
- * Block device partition management.
+ * @brief Block Device Partition Management
*/
/*
diff --git a/cpukit/libblock/include/rtems/blkdev.h b/cpukit/libblock/include/rtems/blkdev.h
index f29a349..fb2dcd4 100644
--- a/cpukit/libblock/include/rtems/blkdev.h
+++ b/cpukit/libblock/include/rtems/blkdev.h
@@ -3,7 +3,7 @@
*
* @ingroup rtems_blkdev
*
- * Block device management.
+ * @brief Block Device Management
*/
/*
diff --git a/cpukit/libblock/include/rtems/diskdevs.h b/cpukit/libblock/include/rtems/diskdevs.h
index 3a9967e..ece629a 100644
--- a/cpukit/libblock/include/rtems/diskdevs.h
+++ b/cpukit/libblock/include/rtems/diskdevs.h
@@ -1,9 +1,9 @@
/**
* @file
*
- * @ingroup rtems_disk
+ * @brief Block Device Disk Management API
*
- * @brief Block device disk management API.
+ * @ingroup rtems_disk
*/
/*
@@ -94,7 +94,7 @@ typedef struct {
typedef struct {
/**
* @brief Read hit count.
- *
+ *
* A read hit occurs in the rtems_bdbuf_read() function in case the block is
* in the cached or modified state.
*/
@@ -102,7 +102,7 @@ typedef struct {
/**
* @brief Read miss count.
- *
+ *
* A read miss occurs in the rtems_bdbuf_read() function in case the block is
* in the empty state and a read transfer must be initiated to read the data
* from the device.
diff --git a/cpukit/libblock/include/rtems/flashdisk.h b/cpukit/libblock/include/rtems/flashdisk.h
index c9f8fd4..4dcdabe 100644
--- a/cpukit/libblock/include/rtems/flashdisk.h
+++ b/cpukit/libblock/include/rtems/flashdisk.h
@@ -3,6 +3,8 @@
*
* @ingroup RTEMSFDisk
*
+ * @brief Interface to a Flash Disk Block Device
+ *
* This file defines the interface to a flash disk block device.
*/
diff --git a/cpukit/libcsupport/include/clockdrv.h b/cpukit/libcsupport/include/clockdrv.h
index fc85c7a..6acf83e 100644
--- a/cpukit/libcsupport/include/clockdrv.h
+++ b/cpukit/libcsupport/include/clockdrv.h
@@ -1,6 +1,8 @@
/**
* @file rtems/clockdrv.h
*
+ * @brief Clock Driver for all Boards
+ *
* This file describes the Clock Driver for all boards.
*/
diff --git a/cpukit/libcsupport/include/timerdrv.h b/cpukit/libcsupport/include/timerdrv.h
index c51768b..b5eb6a1 100644
--- a/cpukit/libcsupport/include/timerdrv.h
+++ b/cpukit/libcsupport/include/timerdrv.h
@@ -1,7 +1,9 @@
/**
* @file rtems/timerdrv.h
*
- * This file describes the Timer Driver for all boards.
+ * @brief Timer Driver for all Boards
+ *
+ * This file describes the Timer Driver for all boards.
*/
/*
diff --git a/cpukit/libcsupport/include/zilog/z8036.h b/cpukit/libcsupport/include/zilog/z8036.h
index 2600036..0e585e1 100644
--- a/cpukit/libcsupport/include/zilog/z8036.h
+++ b/cpukit/libcsupport/include/zilog/z8036.h
@@ -1,6 +1,8 @@
/**
* @file rtems/zilog/z8036.h
*
+ * @brief Zilog Z8036 Counter/Timer/IO Chip
+ *
* This include file defines information related to a Zilog Z8036
* Counter/Timer/IO Chip. It is a memory mapped part.
*
diff --git a/cpukit/libfs/src/pipe/pipe.h b/cpukit/libfs/src/pipe/pipe.h
index 6ba3c5e..158cde5 100644
--- a/cpukit/libfs/src/pipe/pipe.h
+++ b/cpukit/libfs/src/pipe/pipe.h
@@ -1,6 +1,8 @@
/**
* @file rtems/pipe.h
*
+ * @brief Defines the Interface to the POSIX FIFO/pipe File System Support
+ *
* This include file defines the interface to the POSIX FIFO/pipe file system
* support.
*/
@@ -24,7 +26,7 @@ extern "C" {
/**
* @defgroup FIFO_PIPE FIFO/pipe File System Support
- *
+ *
* @brief Interface to the POSIX FIFO/pipe File System
*/
@@ -50,7 +52,7 @@ typedef struct pipe_control {
/**
* @brief Create an Anonymous Pipe
- *
+ *
* Called by pipe() to create an anonymous pipe.
*/
extern int pipe_create(
@@ -59,7 +61,7 @@ extern int pipe_create(
/**
* @brief Release a Pipe
- *
+ *
* Interface to file system close.
*
* *pipep points to pipe control structure. When the last user releases pipe,
@@ -85,7 +87,7 @@ extern int fifo_open(
/**
* @brief Pipe Read
- *
+ *
* Interface to file system read.
*/
extern ssize_t pipe_read(
@@ -97,7 +99,7 @@ extern ssize_t pipe_read(
/**
* @brief Pipe Write
- *
+ *
* Interface to file system write.
*/
extern ssize_t pipe_write(
@@ -109,7 +111,7 @@ extern ssize_t pipe_write(
/**
* @brief Pipe IO Control
- *
+ *
* Interface to file system ioctl.
*/
extern int pipe_ioctl(
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-format.h b/cpukit/libfs/src/rfs/rtems-rfs-format.h
index b977426..56b1aa9 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-format.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-format.h
@@ -1,20 +1,21 @@
-/*
- * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
- *
- * 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 rtems-rfs
*
- * RTEMS File System Format.
+ * @brief RTEMS File System Format
*
* This function lets you format a disk in the RFS format.
*/
+/*
+ * COPYRIGHT (c) 2010 Chris Johns <chrisj at rtems.org>
+ *
+ * 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.
+ */
+
#if !defined (_RTEMS_RFS_FORMAT_H_)
#define _RTEMS_RFS_FORMAT_H_
diff --git a/cpukit/libmisc/bspcmdline/bspcmdline.h b/cpukit/libmisc/bspcmdline/bspcmdline.h
index 7fa03c9..1e48983 100644
--- a/cpukit/libmisc/bspcmdline/bspcmdline.h
+++ b/cpukit/libmisc/bspcmdline/bspcmdline.h
@@ -1,6 +1,9 @@
/**
* @file rtems/bspcmdline.h
*
+ * @brief Related Prototypes and Specifications to
+ * BSP Command Line String and helper routines.
+ *
* This include file contains all prototypes and specifications
* related to the BSP Command Line String and associated helper
* routines. The helpers are useful for locating command line
diff --git a/cpukit/libmisc/fb/mw_uid.h b/cpukit/libmisc/fb/mw_uid.h
index ba91a76..794378b 100644
--- a/cpukit/libmisc/fb/mw_uid.h
+++ b/cpukit/libmisc/fb/mw_uid.h
@@ -1,8 +1,11 @@
/**
* @file rtems/mw_uid.h
*
- * This file defines the interface for input devices used by MicroWindows
- * in an embedded system environment.
+ * @brief Input device Interface for MicroWindows in an
+ * Embedded System Enviroment
+ *
+ * This file defines the interface for input devices used by
+ * MicroWindows in an embedded system environment.
*/
/*
diff --git a/cpukit/libmisc/serdbg/serdbgcnf.h b/cpukit/libmisc/serdbg/serdbgcnf.h
index 90e2d80..9d4087a 100644
--- a/cpukit/libmisc/serdbg/serdbgcnf.h
+++ b/cpukit/libmisc/serdbg/serdbgcnf.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Adds a GDB remote Debug Stub to an RTEMS System
+ */
+
/*===============================================================*\
| Project: RTEMS configure remote gdb over serial line |
+-----------------------------------------------------------------+
diff --git a/cpukit/libmisc/serdbg/termios_printk_cnf.h b/cpukit/libmisc/serdbg/termios_printk_cnf.h
index a69926e..03c3090 100644
--- a/cpukit/libmisc/serdbg/termios_printk_cnf.h
+++ b/cpukit/libmisc/serdbg/termios_printk_cnf.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Adds printk Support via Polled termios
+ */
+
/*===============================================================*\
| Project: RTEMS configure remote gdb over serial line |
+-----------------------------------------------------------------+
diff --git a/cpukit/libmisc/stackchk/stackchk.h b/cpukit/libmisc/stackchk/stackchk.h
index e493171..a5a9bca 100644
--- a/cpukit/libmisc/stackchk/stackchk.h
+++ b/cpukit/libmisc/stackchk/stackchk.h
@@ -1,7 +1,11 @@
-/** @file rtems/stackchk.h
+/**
+ * @file rtems/stackchk.h
+ *
+ * @brief Information Necessary to Utilize and Install the
+ * Stack Checker Mechanism
*
- * This include file contains information necessary to utilize
- * and install the stack checker mechanism.
+ * This include file contains information necessary to utilize
+ * and install the stack checker mechanism.
*/
/*
diff --git a/cpukit/libqos/qreslib.h b/cpukit/libqos/qreslib.h
index 8b5af82..110cc2f 100644
--- a/cpukit/libqos/qreslib.h
+++ b/cpukit/libqos/qreslib.h
@@ -1,8 +1,11 @@
/**
* @file qreslib.h
*
- * This include file contains all the constants and structures associated
- * with the QoS RES library in RTEMS.
+ * @brief Constants and Structures Associated
+ * with the QoS RES library in RTEMS
+ *
+ * This include file contains all the constants and structures
+ * associated with the QoS RES library in RTEMS.
*
* @note The library is available only together with CBS scheduler.
*/
diff --git a/cpukit/sapi/include/confdefs.h b/cpukit/sapi/include/confdefs.h
index 3939cf1..2c0be53 100644
--- a/cpukit/sapi/include/confdefs.h
+++ b/cpukit/sapi/include/confdefs.h
@@ -1,6 +1,9 @@
/**
* @file rtems/confdefs.h
*
+ * @brief Configuration Table Template that will be Instantiated
+ * by an Application
+ *
* This include file contains the configuration table template that will
* be instantiated by an application based on the setting of a number
* of macros. The macros are documented in the Configuring a System
@@ -175,11 +178,11 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
* If configured for SMP, then we need to know the maximum CPU cores.
*/
#if !defined(CONFIGURE_SMP_APPLICATION)
- #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS)
+ #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS)
#define CONFIGURE_SMP_MAXIMUM_PROCESSORS 1
#endif
#else
- #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS)
+ #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS)
#error "CONFIGURE_SMP_MAXIMUM_PROCESSORS not specified for SMP Application"
#endif
#endif
@@ -259,7 +262,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
#error "Configured filesystems but root filesystem was not IMFS!"
#error "Filesystems could be disabled, DEVFS is root, or"
#error " miniIMFS is root!"
- #endif
+ #endif
#endif
/*
@@ -297,7 +300,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
/**
* This defines the miniIMFS file system table entry.
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_miniIMFS) && \
defined(CONFIGURE_FILESYSTEM_MINIIMFS)
#define CONFIGURE_FILESYSTEM_ENTRY_miniIMFS \
@@ -315,7 +318,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
#ifndef RTEMS_SCHEDSIM
/**
* This defines the IMFS file system table entry.
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_IMFS) && \
defined(CONFIGURE_FILESYSTEM_IMFS)
#if defined(CONFIGURE_FIFOS_ENABLED)
@@ -352,7 +355,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
/**
* DEVFS
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_DEVFS) && \
defined(CONFIGURE_FILESYSTEM_DEVFS)
#include <rtems/devfs.h>
@@ -363,9 +366,9 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
#ifdef RTEMS_NETWORKING
/**
* FTPFS
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_FTPFS) && \
- defined(CONFIGURE_FILESYSTEM_FTPFS)
+ defined(CONFIGURE_FILESYSTEM_FTPFS)
#include <rtems/ftpfs.h>
#define CONFIGURE_FILESYSTEM_ENTRY_FTPFS \
{ RTEMS_FILESYSTEM_TYPE_FTPFS, rtems_ftpfs_initialize }
@@ -373,7 +376,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
/**
* TFTPFS
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_TFTPFS) && \
defined(CONFIGURE_FILESYSTEM_TFTPFS)
#include <rtems/tftp.h>
@@ -383,7 +386,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
/**
* NFS
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_NFS) && \
defined(CONFIGURE_FILESYSTEM_NFS)
#include <librtemsNfs.h>
@@ -394,7 +397,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
/**
* DOSFS
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_DOSFS) && \
defined(CONFIGURE_FILESYSTEM_DOSFS)
#include <rtems/dosfs.h>
@@ -404,7 +407,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
/**
* RFS
- */
+ */
#if !defined(CONFIGURE_FILESYSTEM_ENTRY_RFS) && \
defined(CONFIGURE_FILESYSTEM_RFS)
#include <rtems/rtems-rfs.h>
@@ -574,7 +577,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
/*
* Scheduler configuration.
*
- * The scheduler configuration allows an application to select the
+ * The scheduler configuration allows an application to select the
* scheduling policy to use. The supported configurations are:
* CONFIGURE_SCHEDULER_USER - user provided scheduler
* CONFIGURE_SCHEDULER_PRIORITY - Deterministic Priority Scheduler
@@ -582,13 +585,13 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
* CONFIGURE_SCHEDULER_SIMPLE_SMP - Simple SMP Priority Scheduler
* CONFIGURE_SCHEDULER_EDF - EDF Scheduler
* CONFIGURE_SCHEDULER_CBS - CBS Scheduler
- *
- * If no configuration is specified by the application, then
+ *
+ * If no configuration is specified by the application, then
* CONFIGURE_SCHEDULER_PRIORITY is assumed to be the default.
*
* An application can define its own scheduling policy by defining
* CONFIGURE_SCHEDULER_USER and the following:
- * - CONFIGURE_SCHEDULER_ENTRY_POINTS
+ * - CONFIGURE_SCHEDULER_ENTRY_POINTS
* - CONFIGURE_MEMORY_FOR_SCHEDULER - base memory
* - CONFIGURE_MEMORY_PER_TASK_FOR_SCHEDULER - per task memory
*/
@@ -612,7 +615,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
#endif
#endif
-/*
+/*
* If the Priority Scheduler is selected, then configure for it.
*/
#if defined(CONFIGURE_SCHEDULER_PRIORITY)
@@ -630,7 +633,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
_Configure_From_workspace(sizeof(Scheduler_priority_Per_thread)) )
#endif
-/*
+/*
* If the Simple Priority Scheduler is selected, then configure for it.
*/
#if defined(CONFIGURE_SCHEDULER_SIMPLE)
@@ -705,7 +708,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
_Configure_From_workspace(sizeof(Scheduler_CBS_Per_thread)))
#endif
-/*
+/*
* Set up the scheduler entry points table. The scheduling code uses
* this code to know which scheduler is configured by the user.
*/
@@ -858,7 +861,7 @@ rtems_fs_init_functions_t rtems_fs_init_helper =
#define CONFIGURE_UNIFIED_WORK_AREAS
#endif
#endif
-
+
#ifdef CONFIGURE_UNIFIED_WORK_AREAS
Heap_Control *RTEMS_Malloc_Heap = &_Workspace_Area;
#else
diff --git a/cpukit/sapi/include/rtems/cbs.h b/cpukit/sapi/include/rtems/cbs.h
index 9113204..dda56e2 100644
--- a/cpukit/sapi/include/rtems/cbs.h
+++ b/cpukit/sapi/include/rtems/cbs.h
@@ -1,8 +1,11 @@
/**
* @file rtems/cbs.h
*
- * This include file contains all the constants and structures associated
- * with the CBS library in RTEMS.
+ * @brief Constants and Structures Associated
+ * with the CBS library in RTEMS
+ *
+ * This include file contains all the constants and structures associated
+ * with the CBS library in RTEMS.
*/
/*
diff --git a/cpukit/sapi/include/rtems/config.h b/cpukit/sapi/include/rtems/config.h
index 983af84..9a35437 100644
--- a/cpukit/sapi/include/rtems/config.h
+++ b/cpukit/sapi/include/rtems/config.h
@@ -1,6 +1,8 @@
/**
* @file rtems/config.h
*
+ * @brief Table of User Defined Configuration Parameters
+ *
* This include file contains the table of user defined configuration
* parameters.
*/
More information about the vc
mailing list