Header File Doxygen Enhancement Task #7

20 files changed, 71 insertions, 37 deletions

diff --git a/cpukit/include/rtems/btimer.h b/cpukit/include/rtems/btimer.h
index 0e02799734..fb38fd68b2 100644
--- a/cpukit/include/rtems/btimer.h
+++ b/cpukit/include/rtems/btimer.h
@@ -1,7 +1,7 @@
 /**
  * @file rtems/btimer.h
  *
- *  RTEMS benchmark timer API for all boards.
+ * @brief RTEMS Benchmark Timer API for all Boards
  */
 
 /*
@@ -16,7 +16,7 @@
  *  found in the file LICENSE in this distribution or at
  *  http://www.rtems.com/license/LICENSE.
  */
- 
+
 /*
  * All the functions declared as extern after this comment
  * MUST be implemented in each BSP.
diff --git a/cpukit/libblock/include/rtems/nvdisk.h b/cpukit/libblock/include/rtems/nvdisk.h
index c7693fb6fb..0f9cc8fe9d 100644
--- a/cpukit/libblock/include/rtems/nvdisk.h
+++ b/cpukit/libblock/include/rtems/nvdisk.h
@@ -1,7 +1,7 @@
 /**
  * @file rtems/nvdisk.h
  *
- * Non-volatile disk block device implementation
+ * @brief Non-volatile Disk Block Device Implementation
  */
 
 /*
diff --git a/cpukit/libcsupport/include/ringbuf.h b/cpukit/libcsupport/include/ringbuf.h
index 71b0532f41..0e86f39ce9 100644
--- a/cpukit/libcsupport/include/ringbuf.h
+++ b/cpukit/libcsupport/include/ringbuf.h
@@ -1,6 +1,8 @@
 /**
  *  @file rtems/ringbuf.h
  *
+ *  @brief Simple Ring Buffer Functionality
+ *
  *  This file provides simple ring buffer functionality.
  */
 
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 0ed3ded50f..c4933159e0 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/assoc.h
  *
+ * @brief RTEMS Associativity Routines
+ *
  * RTEMS associativity routines.  Mainly used to convert a value from
  * one space to another (eg: our errno's to host errno's and vice-versa)
  */
@@ -139,7 +141,7 @@ const rtems_assoc_t *rtems_assoc_ptr_by_local(
 
 /**
  *  @brief RTEMS Associate Bad Name
- * 
+ *
  *  what to return if a value is not found
  *  this is not reentrant, but it really shouldn't be invoked anyway
  */
diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h
index 056fb8f9c0..31a37e025b 100644
--- a/cpukit/libcsupport/include/rtems/error.h
+++ b/cpukit/libcsupport/include/rtems/error.h
@@ -1,10 +1,12 @@
 /**
  * @file rtems/error.h
  *
+ * @brief RTEMS Error Reporting
+ *
  * Defines and externs for rtems error reporting
- * 
+ *
  * Currently just used by RTEMS monitor.
- * 
+ *
  * These routines provide general purpose error reporting.
  * rtems_error reports an error to stderr and allows use of
  * printf style formatting.  A newline is appended to all messages.
@@ -53,9 +55,9 @@ extern "C" {
  *  @defgroup ErrorPanicSupport Error And Panic Support
  *
  *  @ingroup libcsupport
- * 
+ *
  *  @brief Defines and externs for rtems error reporting
- * 
+ *
  */
 
 typedef Internal_errors_t rtems_error_code_t;
@@ -82,13 +84,13 @@ const char *rtems_status_text(rtems_status_code sc);
 
 /**
  *  @brief Report an Error
- * 
+ *
  *  @param[in] error_code can be specified as any of the following:
  *  RTEMS_ERROR_ERRNO       -- include errno text in output
  *  RTEMS_ERROR_PANIC       -- halts local system after output
  *  RTEMS_ERROR_ABORT       -- abort after output
- * 
- *  @param[in] printf_format is a normal printf(3) format string, 
+ *
+ *  @param[in] printf_format is a normal printf(3) format string,
  *  with its concommitant arguments
  *
  *  @return the number of characters written.
diff --git a/cpukit/libcsupport/include/rtems/framebuffer.h b/cpukit/libcsupport/include/rtems/framebuffer.h
index 8a05f5ac75..a0548d3499 100644
--- a/cpukit/libcsupport/include/rtems/framebuffer.h
+++ b/cpukit/libcsupport/include/rtems/framebuffer.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/framebuffer.h
  *
+ * @brief Frame Buffer Device Driver for all Boards
+ *
  * This file describes the Frame Buffer Device Driver for all boards.
  */
 
diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h
index 84f3dc7451..e7d34b63a9 100644
--- a/cpukit/libcsupport/include/rtems/libio.h
+++ b/cpukit/libcsupport/include/rtems/libio.h
@@ -3,8 +3,8 @@
  *
  * @ingroup LibIO
  *
- * @brief Basic IO API.
- * 
+ * @brief Basic IO API
+ *
  * This file contains the support infrastructure used to manage the
  * table of integer style file descriptors used by the low level
  * POSIX system calls like open(), read, fstat(), etc.
@@ -1257,7 +1257,7 @@ typedef struct {
 
 /**
  * @brief RTEMS LibIO Initialization
- * 
+ *
  * Called by BSP startup code to initialize the libio subsystem.
  */
 void rtems_libio_init(void);
@@ -1384,7 +1384,7 @@ static inline rtems_device_minor_number rtems_filesystem_dev_minor_t(
 
 /**
  *  @brief Base File System Initialization
- *  
+ *
  *  Initialize the foundation of the file system.  This is specified
  *  by the structure rtems_filesystem_mount_table.  The usual
  *  configuration is a single instantiation of the IMFS or miniIMFS with
diff --git a/cpukit/libi2c/libi2c.h b/cpukit/libi2c/libi2c.h
index 04c20a64b7..8c2f072da2 100644
--- a/cpukit/libi2c/libi2c.h
+++ b/cpukit/libi2c/libi2c.h
@@ -3,7 +3,7 @@
  *
  * @ingroup libi2c
  *
- * @brief I2C library.
+ * @brief I2C Library
  */
 
 #ifndef _RTEMS_LIBI2C_H
diff --git a/cpukit/libmisc/capture/capture.h b/cpukit/libmisc/capture/capture.h
index 034bdb9c86..d75f675b27 100644
--- a/cpukit/libmisc/capture/capture.h
+++ b/cpukit/libmisc/capture/capture.h
@@ -1,6 +1,9 @@
 /**
  * @file rtems/capture.h
  *
+ * @brief Capture Engine Component of the RTEMS Measurement and
+ * Monitoring System
+ *
  * This is the Capture Engine component of the RTEMS Measurement and
  * Monitoring system.
  */
diff --git a/cpukit/libmisc/cpuuse/cpuuse.h b/cpukit/libmisc/cpuuse/cpuuse.h
index 7dfe5ba388..a89c7dd346 100644
--- a/cpukit/libmisc/cpuuse/cpuuse.h
+++ b/cpukit/libmisc/cpuuse/cpuuse.h
@@ -1,6 +1,9 @@
 /**
  * @file rtems/cpuuse.h
  *
+ * @brief Information Necessary to Utilize
+ * and Install the CPU Usage Reporting Mechanism
+ *
  * This include file contains information necessary to utilize
  * and install the cpu usage reporting mechanism.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/attr.h b/cpukit/rtems/include/rtems/rtems/attr.h
index 674ee08eff..20c4ae2f16 100644
--- a/cpukit/rtems/include/rtems/rtems/attr.h
+++ b/cpukit/rtems/include/rtems/rtems/attr.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/attr.h
  *
+ * @brief Information about the Object Attributes Handler
+ *
  *  This include file contains all information about the Object Attributes
  *  Handler.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index 42601d5779..1ea1e02faf 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -1,6 +1,9 @@
 /**
  * @file rtems/rtems/dpmem.h
  *
+ * @brief Constants and Structures Associated with the Dual Ported Memory
+ * Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Dual Ported Memory Manager. This manager provides a mechanism
  *  for converting addresses between internal and external representations
@@ -92,13 +95,13 @@ void _Dual_ported_memory_Manager_initialization(void);
  *  memory of length bytes which has internal_start and external_start
  *  as the internal and external starting addresses, respectively.
  *  It returns the id of the created port in ID.
- * 
+ *
  *  @param[in] name is the user defined port name
  *  @param[in] internal_start is the internal start address of port
  *  @param[in] external_start is the external start address of port
  *  @param[in] length is the physical length in bytes
  *  @param[out] id is the address of port id to set
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.  If successful, the id will
@@ -118,10 +121,10 @@ rtems_status_code rtems_port_create(
  *  This routine implements the rtems_port_ident directive.  This directive
  *  returns the port ID associated with name.  If more than one port is
  *  named name, then the port to which the ID belongs is arbitrary.
- * 
+ *
  *  @param[in] name is the user defined port name
  *  @param[out] id is the pointer to port id
- * 
+ *
  *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
  */
 rtems_status_code rtems_port_ident(
@@ -134,9 +137,9 @@ rtems_status_code rtems_port_ident(
  *
  *  This routine implements the rtems_port_delete directive.  It deletes
  *  the port associated with ID.
- * 
+ *
  *  @param[in] id is the dual-ported memory area id
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.
@@ -151,13 +154,13 @@ rtems_status_code rtems_port_delete(
  *  This routine implements the rtems_port_external_to_internal directive.
  *  It returns the internal port address which maps to the provided
  *  external port address for the specified port ID.If the given external
- *  address is an invalid dual-ported address, then the internal address is 
+ *  address is an invalid dual-ported address, then the internal address is
  *  set to the given external address.
- * 
+ *
  *  @param[in] id is the id of dp memory object
  *  @param[in] external is the external address
  *  @param[out] internal is the pointer of internal address to set
- * 
+ *
  *  @return RTEMS_SUCCESSFUL
  */
 rtems_status_code rtems_port_external_to_internal(
@@ -174,12 +177,12 @@ rtems_status_code rtems_port_external_to_internal(
  *  internal port address for the specified port ID.  If the given
  *  internal address is an invalid dual-ported address, then the
  *  external address is set to the given internal address.
- * 
+ *
  *  @param[in] id is the id of dual-ported memory object
  *  @param[in] internal is the internal address to set
  *  @param[in] external is the pointer to external address
- * 
- *  @return RTEMS_SUCCESSFUL and the external will be filled in 
+ *
+ *  @return RTEMS_SUCCESSFUL and the external will be filled in
  *  with the external addresses
  */
 rtems_status_code rtems_port_internal_to_external(
diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h
index 7baa80c652..c4e99cbeff 100644
--- a/cpukit/rtems/include/rtems/rtems/object.h
+++ b/cpukit/rtems/include/rtems/rtems/object.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/object.h
  *
+ * @brief Classic API interfaces to Object Services
+ *
  * This include file defines Classic API interfaces to Object Services.
  */
 
diff --git a/cpukit/rtems/include/rtems/rtems/rtemsapi.h b/cpukit/rtems/include/rtems/rtems/rtemsapi.h
index 5d74fa6790..29b4d1be37 100644
--- a/cpukit/rtems/include/rtems/rtems/rtemsapi.h
+++ b/cpukit/rtems/include/rtems/rtems/rtemsapi.h
@@ -1,7 +1,7 @@
 /**
  * @file rtems/rtems/rtemsapi.h
  *
- *  RTEMS API Support
+ * @brief RTEMS API Support
  */
 
 /*  COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index ea0aea32ca..5e851bcdc2 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/sem.h
  *
+ * @brief Constants and Structures Associated with the Semaphore Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Semaphore Manager.  This manager utilizes standard Dijkstra
  *  counting semaphores to provide synchronization and mutual exclusion
diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h
index 6e242544a3..b6430e251a 100644
--- a/cpukit/rtems/include/rtems/rtems/signal.h
+++ b/cpukit/rtems/include/rtems/rtems/signal.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/signal.h
  *
+ * @brief Constants and Structures Associated with the Signal Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Signal Manager.   This manager provides capabilities required
  *  for asynchronous communication between tasks via signal sets.
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index 607f87ca57..c4ccafb824 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/tasks.h
  *
+ * @brief Constants and Structures Associated with RTEMS Tasks
+ *
  *  This include file contains all constants and structures associated
  *  with RTEMS tasks.  This manager provides a comprehensive set of directives
  *  to create, delete, and administer tasks.
diff --git a/cpukit/sapi/include/rtems/init.h b/cpukit/sapi/include/rtems/init.h
index 8b5fab91fd..d357c113df 100644
--- a/cpukit/sapi/include/rtems/init.h
+++ b/cpukit/sapi/include/rtems/init.h
@@ -1,6 +1,8 @@
 /**
  * @file rtems/init.h
  *
+ * @brief Constants and Structures Associated
+ * with the Initialization Manager
  *
  *  This include file contains all the constants and structures associated
  *  with the Initialization Manager.  This manager is responsible for
diff --git a/cpukit/sapi/include/rtems/mptables.h b/cpukit/sapi/include/rtems/mptables.h
index c46a367a33..52db445833 100644
--- a/cpukit/sapi/include/rtems/mptables.h
+++ b/cpukit/sapi/include/rtems/mptables.h
@@ -1,6 +1,9 @@
 /**
  * @file rtems/mptables.h
  *
+ * @brief Executive's Pre-Initialized Tables used in a
+ * Multiprocessor Configuration
+ *
  * This include file contains the executive's pre-initialized tables
  * used in a multiprocessor configuration.
  */
diff --git a/cpukit/score/include/rtems/bspsmp.h b/cpukit/score/include/rtems/bspsmp.h
index 9c040efeda..fa1b65b815 100644
--- a/cpukit/score/include/rtems/bspsmp.h
+++ b/cpukit/score/include/rtems/bspsmp.h
@@ -1,9 +1,11 @@
 /**
  *  @file  rtems/bspsmp.h
  *
+ *  @brief Interface Between RTEMS and an SMP Aware BSP
+ *
  *  This include file defines the interface between RTEMS and an
  *  SMP aware BSP.  These methods will only be used when RTEMS
- *  is configured with SMP support enabled. 
+ *  is configured with SMP support enabled.
  */
 
 /*
@@ -25,7 +27,7 @@
  *  @defgroup RTEMS BSP SMP Interface
  *
  *  This defines the interface between RTEMS and the BSP for
- *  SMP support.  The interface uses the term primary 
+ *  SMP support.  The interface uses the term primary
  *  to refer to the "boot" processor and secondary to refer
  *  to the "application" processors.  Different architectures
  *  use different terminology.
@@ -51,7 +53,7 @@ extern "C" {
  *  indicate the Maximum number of CPUs in this system.
  */
 extern uint32_t rtems_configuration_smp_maximum_processors;
- 
+
 /**
  *  @brief Initialize Secondary CPUs
  *
@@ -97,11 +99,11 @@ void rtems_smp_send_message(
  *  @brief Generate a Interprocessor Broadcast Interrupt
  *
  *  This method is invoked when RTEMS wants to let all of the other
- *  CPUs know that it has sent them message.  CPUs not including 
+ *  CPUs know that it has sent them message.  CPUs not including
  *  the originating CPU should receive the interrupt.
 
  *
- *  @note On CPUs without the capability to generate a broadcast 
+ *  @note On CPUs without the capability to generate a broadcast
  *        to all other CPUs interrupt, this can be implemented by
  *        a loop of sending interrupts to specific CPUs.
  */
@@ -152,7 +154,7 @@ void bsp_smp_secondary_cpu_initialize(int cpu);
  *  @note This is provided by RTEMS.
  */
 void rtems_smp_secondary_cpu_initialize(void);
- 
+
 /**
  *  This method is invoked by the BSP to initialize the per CPU structure
  *  for the specified @a cpu while it is bringing the secondary CPUs
@@ -167,7 +169,7 @@ void rtems_smp_initialize_per_cpu(int cpu);
  *  @brief RTEMS SMP Proccess Interrupt
  *
  *  This is the method called by the BSP's interrupt handler
- *  to process the incoming interprocessor request. 
+ *  to process the incoming interprocessor request.
  */
 void rtems_smp_process_interrupt(void);
 
@@ -184,7 +186,7 @@ void bsp_smp_wait_for(
 #endif
 
 #else
-  #define bsp_smp_processor_id()  0 
+  #define bsp_smp_processor_id()  0
 #endif
 
 #endif