summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:06 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2013-01-10 17:06:47 -0600
commite858f7049c6407648e624cb43a1819237541fd84 (patch)
treeec6a688ecef9bd271eab37ca652dc172935acb1d /cpukit/rtems/include/rtems/rtems
parentdevfs: Doxygen Warning Removal and Cleanup (diff)
downloadrtems-e858f7049c6407648e624cb43a1819237541fd84.tar.bz2
cpukit: Fix many Doxygen warnings
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/clock.h10
-rw-r--r--cpukit/rtems/include/rtems/rtems/ratemon.h2
-rw-r--r--cpukit/rtems/include/rtems/rtems/region.h2
-rw-r--r--cpukit/rtems/include/rtems/rtems/sem.h2
4 files changed, 9 insertions, 7 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h
index c5355230f9..3254b59dc1 100644
--- a/cpukit/rtems/include/rtems/rtems/clock.h
+++ b/cpukit/rtems/include/rtems/rtems/clock.h
@@ -230,10 +230,8 @@ rtems_status_code rtems_clock_set_nanoseconds_extension(
*
* @retval 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 uptime will be
+ * source of the error. If successful, the @a uptime will be
* filled in.
- *
- * Clock Manager - get uptime
*/
rtems_status_code rtems_clock_get_uptime(
struct timespec *uptime
@@ -242,7 +240,11 @@ rtems_status_code rtems_clock_get_uptime(
/**
* @brief Gets the System Uptime in the Struct Timeval Format
*
- * @param[out] Returns the system uptime. Pointer must not be NULL.
+ * @param[out] uptime is a pointer to a struct timeval structure.
+ *
+ * @retval This methods returns the system uptime.
+ *
+ * @note Pointer must not be NULL.
*/
void rtems_clock_get_uptime_timeval( struct timeval *uptime );
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h
index 91b84e3a26..634889aeeb 100644
--- a/cpukit/rtems/include/rtems/rtems/ratemon.h
+++ b/cpukit/rtems/include/rtems/rtems/ratemon.h
@@ -434,7 +434,7 @@ void rtems_rate_monotonic_report_statistics( void );
* result is set to indicate the current state of the period.
*
* @param[in] id is the rate monotonic id
- * @param[in] lenght is the length of period (in ticks)
+ * @param[in] length is the length of period (in ticks)
*
* @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h
index 17519a5791..a99a497b8d 100644
--- a/cpukit/rtems/include/rtems/rtems/region.h
+++ b/cpukit/rtems/include/rtems/rtems/region.h
@@ -306,7 +306,7 @@ rtems_status_code rtems_region_return_segment(
* satisfied.
*
* @param[in] id is the region id
- * @param[in] segmet is the pointer to segment address
+ * @param[in] segment is the pointer to segment address
* @param[in] size is the new required size
* @retval RTEMS_SUCCESSFUL if operation successful, RTEMS_UNSATISFIED if the
* the segment can't be resized in place or any other code at failure
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index 4442b1d68c..dafd1eac0d 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -271,7 +271,7 @@ rtems_status_code _Semaphore_Translate_core_mutex_return_code (
* This function returns a RTEMS status code based on the semaphore
* status code specified.
*
- * @param[in] status is the semaphore status code to translate
+ * @param[in] the_mutex_status is the semaphore status code to translate
*
* @retval translated RTEMS status code
*/