summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-28 11:30:27 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-28 11:30:27 -0600
commitf3255a6f2243de82f7500641c16aa4360e29447a (patch)
tree572646e57899076100e980aa28986456914f1f6f
parentHeader File Doxygen Enhancement Task #7 (diff)
downloadrtems-f3255a6f2243de82f7500641c16aa4360e29447a.tar.bz2
Header File Doxygen Enhancement Task #11
-rw-r--r--cpukit/include/rtems/fs.h2
-rw-r--r--cpukit/libcsupport/include/sys/statvfs.h2
-rw-r--r--cpukit/libcsupport/include/sys/termios.h2
-rw-r--r--cpukit/libcsupport/include/sys/utsname.h2
-rw-r--r--cpukit/libmisc/devnull/devzero.h2
-rw-r--r--cpukit/libmisc/monitor/monitor.h2
-rw-r--r--cpukit/libmisc/shell/shell.h2
-rw-r--r--cpukit/posix/include/rtems/posix/semaphore.h2
-rw-r--r--cpukit/rtems/include/rtems.h6
9 files changed, 16 insertions, 6 deletions
diff --git a/cpukit/include/rtems/fs.h b/cpukit/include/rtems/fs.h
index 6270877ee5..a403e66f3c 100644
--- a/cpukit/include/rtems/fs.h
+++ b/cpukit/include/rtems/fs.h
@@ -1,6 +1,8 @@
/**
* @file rtems/fs.h
*
+ * @brief Basic Filesystem Types
+ *
* This file defines basic filesystem types
*/
diff --git a/cpukit/libcsupport/include/sys/statvfs.h b/cpukit/libcsupport/include/sys/statvfs.h
index 13185e7e2e..8872670d80 100644
--- a/cpukit/libcsupport/include/sys/statvfs.h
+++ b/cpukit/libcsupport/include/sys/statvfs.h
@@ -1,6 +1,8 @@
/**
* @file sys/statvfs.h
*
+ * @brief Interface to the statvfs() set of API Methods
+ *
* This include file defines the interface to the statvfs() set of
* API methods. The statvfs as defined by the SUS:
*
diff --git a/cpukit/libcsupport/include/sys/termios.h b/cpukit/libcsupport/include/sys/termios.h
index 1046eb8c87..cc8440891a 100644
--- a/cpukit/libcsupport/include/sys/termios.h
+++ b/cpukit/libcsupport/include/sys/termios.h
@@ -1,7 +1,7 @@
/**
* @file sys/termios.h
*
- * @brief POSIX termios implementation for RTEMS console device driver.
+ * @brief POSIX termios Implementation for RTEMS Console Device Driver
*
* The Open Group Base Specifications Issue 6
* IEEE Std 1003.1, 2004 Edition
diff --git a/cpukit/libcsupport/include/sys/utsname.h b/cpukit/libcsupport/include/sys/utsname.h
index a56d74abfd..df3cc675ad 100644
--- a/cpukit/libcsupport/include/sys/utsname.h
+++ b/cpukit/libcsupport/include/sys/utsname.h
@@ -1,6 +1,8 @@
/**
* @file sys/utsname.h
*
+ * @brief Interface to the POSIX utsname() Service
+ *
* This include file defines the interface to the POSIX utsname() service.
*/
diff --git a/cpukit/libmisc/devnull/devzero.h b/cpukit/libmisc/devnull/devzero.h
index aaf084cc32..f1b3d5228f 100644
--- a/cpukit/libmisc/devnull/devzero.h
+++ b/cpukit/libmisc/devnull/devzero.h
@@ -1,6 +1,8 @@
/**
* @file rtems/devzero.h
*
+ * @brief Interface to the RTEMS /dev/zero Device Driver
+ *
* This include file defines the interface to the RTEMS /dev/zero
* device driver.
*/
diff --git a/cpukit/libmisc/monitor/monitor.h b/cpukit/libmisc/monitor/monitor.h
index ba3a61e62b..aedde1a848 100644
--- a/cpukit/libmisc/monitor/monitor.h
+++ b/cpukit/libmisc/monitor/monitor.h
@@ -1,7 +1,7 @@
/**
* @file rtems/monitor.h
*
- * The RTEMS monitor task.
+ * @brief The RTEMS Monitor Task
*/
diff --git a/cpukit/libmisc/shell/shell.h b/cpukit/libmisc/shell/shell.h
index eb55361a67..079ef667af 100644
--- a/cpukit/libmisc/shell/shell.h
+++ b/cpukit/libmisc/shell/shell.h
@@ -1,7 +1,7 @@
/**
* @file rtems/shell.h
*
- * Instantatiate a new terminal shell.
+ * @brief Instantatiate a New Terminal Shell
*/
/*
diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h
index 6390f22110..d7263b3e72 100644
--- a/cpukit/posix/include/rtems/posix/semaphore.h
+++ b/cpukit/posix/include/rtems/posix/semaphore.h
@@ -1,6 +1,8 @@
/**
* @file rtems/posix/semaphore.h
*
+ * @brief Private Support Information for POSIX Semaphores
+ *
* This include file contains all the private support information for
* POSIX Semaphores.
*/
diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h
index 68c6a0b7b9..d989a02aac 100644
--- a/cpukit/rtems/include/rtems.h
+++ b/cpukit/rtems/include/rtems.h
@@ -3,7 +3,7 @@
*
* @ingroup ClassicRTEMS
*
- * @brief Provides the public interface to the RTEMS Classic API.
+ * @brief Provides the Public Interface to the RTEMS Classic API
*/
/* COPYRIGHT (c) 1989-2008.
@@ -158,7 +158,7 @@ const char *rtems_get_version_string(void);
* risk of blown stacks for most user applications. Using this constant when
* specifying the task stack size, indicates that the stack size will be at
* least RTEMS_MINIMUM_STACK_SIZE bytes in size. If the user configured minimum
- * stack size is larger than the recommended minimum, then it will be used.
+ * stack size is larger than the recommended minimum, then it will be used.
*/
#define RTEMS_MINIMUM_STACK_SIZE STACK_MINIMUM_SIZE
@@ -174,7 +174,7 @@ const char *rtems_get_version_string(void);
* minimum stack size value, you may get a stack size that is smaller or larger
* than the recommended minimum. This can be used to provide large stacks for
* all tasks on complex applications or small stacks on applications that are
- * trying to conserve memory.
+ * trying to conserve memory.
*/
#define RTEMS_CONFIGURED_MINIMUM_STACK_SIZE 0