diff options
author | Mathew Kallada <matkallada@gmail.com> | 2012-12-28 11:16:29 -0600 |
---|---|---|
committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2012-12-28 11:17:49 -0600 |
commit | c5782a26b304202546a073a036cbe9e00a789307 (patch) | |
tree | 49f7b4e2a29da7c9ea713465bfec36cee3f353b9 /cpukit/rtems | |
parent | barrier.h: Use POSIX API Doxygen group (diff) | |
download | rtems-c5782a26b304202546a073a036cbe9e00a789307.tar.bz2 |
Header File Doxygen Enhancement Task #7
Diffstat (limited to 'cpukit/rtems')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/attr.h | 2 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/dpmem.h | 27 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/object.h | 2 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/rtemsapi.h | 2 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/sem.h | 2 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/signal.h | 2 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/tasks.h | 2 |
7 files changed, 26 insertions, 13 deletions
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. |