[rtems commit] Fix more Doxygen typos
Joel Sherril
joel at rtems.org
Fri Mar 6 19:26:24 UTC 2015
Module: rtems
Branch: master
Commit: e0eb07a22b6d4e517ed6c69c25af4f6f783a69e9
Changeset: http://git.rtems.org/rtems/commit/?id=e0eb07a22b6d4e517ed6c69c25af4f6f783a69e9
Author: Joel Sherrill <joel.sherrill at oarcorp.com>
Date: Fri Mar 6 13:26:12 2015 -0600
Fix more Doxygen typos
---
cpukit/libdl/rtl-allocator.h | 2 +-
cpukit/libdl/rtl.h | 7 ++++---
cpukit/libfs/src/devfs/devfs.h | 5 ++---
cpukit/rtems/include/rtems/rtems/event.h | 2 +-
cpukit/score/include/rtems/score/cpuset.h | 2 +-
cpukit/score/include/rtems/score/scheduleredfimpl.h | 2 +-
cpukit/score/include/rtems/score/threadqimpl.h | 6 +++---
7 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/cpukit/libdl/rtl-allocator.h b/cpukit/libdl/rtl-allocator.h
index 8e90b7b..4d996d3 100644
--- a/cpukit/libdl/rtl-allocator.h
+++ b/cpukit/libdl/rtl-allocator.h
@@ -147,7 +147,7 @@ void rtems_rtl_alloc_indirect_del (rtems_rtl_alloc_tag_t tag,
* @param const_base Pointer to the const base pointer.
* @param const_size The size of the read only section.
* @param data_base Pointer to the data base pointer.
- * @prarm data_size The size of the read/write secton.
+ * @param data_size The size of the read/write secton.
* @param bss_base Pointer to the bss base pointer.
* @param bss_size The size of the read/write.
* @retval true The memory has been allocated.
diff --git a/cpukit/libdl/rtl.h b/cpukit/libdl/rtl.h
index d0a0d00..15d84c1 100644
--- a/cpukit/libdl/rtl.h
+++ b/cpukit/libdl/rtl.h
@@ -5,6 +5,7 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
+
/**
* @file
*
@@ -224,7 +225,7 @@ rtems_rtl_obj_t* rtems_rtl_find_obj (const char* name);
* 2. Relative file references an object format file in the search path.
*
* 3. Absolute archive and file reference to a specific location in the file
- * system. The archive and file are encoded as 'archive:file [@offset]'
+ * system. The archive and file are encoded as 'archive:file [@@offset]'
* where 'archive' is a valid file at the absolute path in the file system,
* and 'file' is a contained in the archive, and optionally an offset to
* the 'file' in the 'archive'. If no offset is provided the archive is
@@ -275,7 +276,7 @@ int rtems_rtl_get_error (char* message, size_t max_message);
/**
* Append the path to the search path.
*
- * @path The path to append.
+ * @param path The path to append.
* @retval false The path could not be appended.
* @retval true The path was appended.
*/
@@ -284,7 +285,7 @@ bool rtems_rtl_path_append (const char* path);
/**
* Prepend the path to the search path.
*
- * @path The path to prepend.
+ * @param path The path to prepend.
* @retval false The path could not be prepended.
* @retval true The path was prepended.
*/
diff --git a/cpukit/libfs/src/devfs/devfs.h b/cpukit/libfs/src/devfs/devfs.h
index 6b8fae1..b0a9197 100644
--- a/cpukit/libfs/src/devfs/devfs.h
+++ b/cpukit/libfs/src/devfs/devfs.h
@@ -20,7 +20,6 @@
* @brief This structure defines the type of device table
*/
/**@{*/
-
#ifdef __cplusplus
extern "C" {
#endif
@@ -241,7 +240,7 @@ extern int devFS_initialize(
* /dev/clock 1 0
* /dev/tty0 0 0
* /flash 2 0
- * @end code
+ * @endcode
*
* This routine is intended for debugging, and can be used by shell
* program to provide user with the system information.
@@ -251,6 +250,6 @@ extern void devFS_Show(void);
#ifdef __cplusplus
}
#endif
-/** @} */
+/**@}*/
#endif
diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h
index 451a313..dce7de1 100644
--- a/cpukit/rtems/include/rtems/rtems/event.h
+++ b/cpukit/rtems/include/rtems/rtems/event.h
@@ -224,7 +224,7 @@ rtems_status_code rtems_event_send (
* This directive attempts to receive the event condition specified in
* @a event_in. If @a event_in is set to @ref RTEMS_PENDING_EVENTS, then the
* current pending events are returned in @a event_out and left pending. The
- * @aref RTEMS_WAIT and @aref RTEMS_NO_WAIT options in the @a option_set
+ * @ref RTEMS_WAIT and @ref RTEMS_NO_WAIT options in the @a option_set
* parameter are used to specify whether or not the task is willing to wait
* for the event condition to be satisfied. The @ref RTEMS_EVENT_ANY and @ref
* RTEMS_EVENT_ALL are used in the @a option_set parameter to specify whether
diff --git a/cpukit/score/include/rtems/score/cpuset.h b/cpukit/score/include/rtems/score/cpuset.h
index 0f781d9..ebdb35d 100644
--- a/cpukit/score/include/rtems/score/cpuset.h
+++ b/cpukit/score/include/rtems/score/cpuset.h
@@ -30,7 +30,7 @@ extern "C" {
#endif
/**
- * @defgroup ScoreCpuset
+ * @defgroup ScoreCpuset SuperCore CPU Set
*
* @ingroup Score
*
diff --git a/cpukit/score/include/rtems/score/scheduleredfimpl.h b/cpukit/score/include/rtems/score/scheduleredfimpl.h
index a98fb0f..af0749d 100644
--- a/cpukit/score/include/rtems/score/scheduleredfimpl.h
+++ b/cpukit/score/include/rtems/score/scheduleredfimpl.h
@@ -26,7 +26,7 @@ extern "C" {
#endif
/**
- * @addtogroup ScoreSchedulerEDF EDF
+ * @addtogroup ScoreSchedulerEDF
*
* @{
*/
diff --git a/cpukit/score/include/rtems/score/threadqimpl.h b/cpukit/score/include/rtems/score/threadqimpl.h
index 5931d22..4a1084d 100644
--- a/cpukit/score/include/rtems/score/threadqimpl.h
+++ b/cpukit/score/include/rtems/score/threadqimpl.h
@@ -256,9 +256,9 @@ void _Thread_queue_Process_timeout(
* @param[in] left points to the left thread's RBnode
* @param[in] right points to the right thread's RBnode
*
- * @retval 1 The @left node is more important than @right node.
- * @retval 0 The @left node is of equal importance with @right node.
- * @retval 1 The @left node is less important than @right node.
+ * @retval 1 The @a left node is more important than @a right node.
+ * @retval 0 The @a left node is of equal importance with @a right node.
+ * @retval 1 The @a left node is less important than @a right node.
*/
RBTree_Compare_result _Thread_queue_Compare_priority(
const RBTree_Node *left,
More information about the vc
mailing list