[rtems commit] documentation: Fix Doxygen comments
Sebastian Huber
sebh at rtems.org
Fri Jun 14 14:22:56 UTC 2013
Module: rtems
Branch: master
Commit: 961669db4e08be0329661ea99597e99769990659
Changeset: http://git.rtems.org/rtems/commit/?id=961669db4e08be0329661ea99597e99769990659
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Fri Jun 14 15:30:37 2013 +0200
documentation: Fix Doxygen comments
---
cpukit/libfs/src/dosfs/dosfs.h | 22 ++++++++++----------
cpukit/score/cpu/no_cpu/rtems/score/cpusmplock.h | 8 +++---
cpukit/score/include/rtems/score/scheduler.h | 2 +-
cpukit/score/include/rtems/score/scheduleredf.h | 2 +-
.../score/include/rtems/score/schedulerpriority.h | 2 +-
cpukit/score/include/rtems/score/schedulersimple.h | 2 +-
cpukit/score/include/rtems/score/smplock.h | 8 +++---
cpukit/score/include/rtems/score/thread.h | 2 +-
cpukit/score/inline/rtems/score/chain.inl | 4 +-
cpukit/score/inline/rtems/score/scheduler.inl | 4 +-
10 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/cpukit/libfs/src/dosfs/dosfs.h b/cpukit/libfs/src/dosfs/dosfs.h
index 3dc85ed..b0f56c5 100644
--- a/cpukit/libfs/src/dosfs/dosfs.h
+++ b/cpukit/libfs/src/dosfs/dosfs.h
@@ -33,11 +33,11 @@ typedef struct rtems_dosfs_convert_control rtems_dosfs_convert_control;
/**
* @brief Converts from UTF-8 into a specific code page.
*
- * @param[in/out] self The convert control.
+ * @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-8 string to be converted.
* @param[in] src_size The size of the string in bytes (inludes '\0' if any).
* @param[out] dst The address the converted string will get copied to.
- * @param[in/out] dst_size The size of the buffer in bytes respectively the
+ * @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer.
*
* @retval 0 Successful operation.
@@ -55,11 +55,11 @@ typedef int (*rtems_dosfs_utf8_to_codepage)(
/**
* @brief Converts from a specific code page into UTF-8
*
- * @param[in/out] self The convert control.
+ * @param[in,out] self The convert control.
* @param[in] src A well-formed string in code page format.
* @param[in] src_size The size of the string in bytes (inludes '\0' if any).
* @param[out] dst The address the converted string will get copied to.
- * @param[in/out] dst_size The size of the buffer in bytes respectively the
+ * @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer.
*
* @retval 0 Successful operation.
@@ -77,11 +77,11 @@ typedef int (*rtems_dosfs_codepage_to_utf8)(
/**
* @brief Converts from UTF-8 to UTF-16
*
- * @param[in/out] self The convert control.
+ * @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-8 string to be converted.
* @param[in] src_size The size of the string in bytes (inludes '\0' if any).
* @param[out] dst The address the converted string will get copied to
- * @param[in/out] dst_size The size of the buffer in bytes respectively the
+ * @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer.
*
* @retval 0 Successful operation.
@@ -99,11 +99,11 @@ typedef int (*rtems_dosfs_utf8_to_utf16)(
/**
* @brief Converts from UTF-16 to UTF-8.
*
- * @param[in/out] self The convert control.
+ * @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-16 string to be converted.
* @param[in] src_size The size of the string in bytes (inludes '\0' if any).
* @param[out] dst The address the converted string will get copied to.
- * @param[in/out] dst_size The size of the buffer in bytes respectively the
+ * @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer
*
* @retval 0 Successful operation.
@@ -124,12 +124,12 @@ typedef int (*rtems_dosfs_utf16_to_utf8)(
* Does canonical decomposition of the UTF-8 string and in addition
* also converts upper case alphabetic characters to lower case characters
*
- * @param[in/out] self The convert control.
+ * @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-8 string to be normalized and fold.
* @param[in] src_size The size of the string in bytes (inludes '\0' if any).
* @param[out] dst The address the normalized and fold string will get
* copied to.
- * @param[in/out] dst_size The size of the buffer in bytes respectively the
+ * @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer.
*
* @retval 0 Successful operation.
@@ -149,7 +149,7 @@ typedef int (*rtems_dosfs_utf8_normalize_and_fold)(
/**
* @brief Destroys a convert control structure.
*
- * @param[in/out] self The convert control for destruction.
+ * @param[in,out] self The convert control for destruction.
*/
typedef void (*rtems_dosfs_convert_destroy)(
rtems_dosfs_convert_control *self
diff --git a/cpukit/score/cpu/no_cpu/rtems/score/cpusmplock.h b/cpukit/score/cpu/no_cpu/rtems/score/cpusmplock.h
index 387bbb4..479a12a 100644
--- a/cpukit/score/cpu/no_cpu/rtems/score/cpusmplock.h
+++ b/cpukit/score/cpu/no_cpu/rtems/score/cpusmplock.h
@@ -60,7 +60,7 @@ static inline void _CPU_SMP_lock_Initialize( CPU_SMP_lock_Control *lock )
/**
* @brief Acquires a CPU SMP lock.
*
- * @param[in/out] lock The CPU SMP lock control.
+ * @param[in,out] lock The CPU SMP lock control.
*/
static inline void _CPU_SMP_lock_Acquire( CPU_SMP_lock_Control *lock )
{
@@ -74,7 +74,7 @@ static inline void _CPU_SMP_lock_Acquire( CPU_SMP_lock_Control *lock )
/**
* @brief Releases a CPU SMP lock.
*
- * @param[in/out] lock The CPU SMP lock control.
+ * @param[in,out] lock The CPU SMP lock control.
*/
static inline void _CPU_SMP_lock_Release( CPU_SMP_lock_Control *lock )
{
@@ -84,7 +84,7 @@ static inline void _CPU_SMP_lock_Release( CPU_SMP_lock_Control *lock )
/**
* @brief Disables interrupts and acquires the CPU SMP lock.
*
- * @param[in/out] lock The CPU SMP lock control.
+ * @param[in,out] lock The CPU SMP lock control.
* @param[out] isr_cookie The ISR cookie.
*/
#define _CPU_SMP_lock_ISR_disable_and_acquire( lock, isr_cookie ) \
@@ -96,7 +96,7 @@ static inline void _CPU_SMP_lock_Release( CPU_SMP_lock_Control *lock )
/**
* @brief Releases the CPU SMP lock and enables interrupts.
*
- * @param[in/out] lock The CPU SMP lock control.
+ * @param[in,out] lock The CPU SMP lock control.
* @param[in] isr_cookie The ISR cookie.
*/
#define _CPU_SMP_lock_Release_and_ISR_enable( lock, isr_cookie ) \
diff --git a/cpukit/score/include/rtems/score/scheduler.h b/cpukit/score/include/rtems/score/scheduler.h
index 563d6c9..70b9e33 100644
--- a/cpukit/score/include/rtems/score/scheduler.h
+++ b/cpukit/score/include/rtems/score/scheduler.h
@@ -160,7 +160,7 @@ void _Scheduler_default_Tick( void );
/**
* @brief Unblocks the thread.
*
- * @param[in/out] thread An idle thread.
+ * @param[in,out] thread An idle thread.
* @param[in] processor This parameter is unused.
*/
void _Scheduler_default_Start_idle(
diff --git a/cpukit/score/include/rtems/score/scheduleredf.h b/cpukit/score/include/rtems/score/scheduleredf.h
index 090974b..b28bed1 100644
--- a/cpukit/score/include/rtems/score/scheduleredf.h
+++ b/cpukit/score/include/rtems/score/scheduleredf.h
@@ -193,7 +193,7 @@ void _Scheduler_EDF_Unblock(
* and place it back. The rbtree ready queue is responsible for FIFO ordering
* in such a case.
*
- * @param[in/out] thread The yielding thread.
+ * @param[in,out] thread The yielding thread.
*/
void _Scheduler_EDF_Yield( Thread_Control *thread );
diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h
index f6fdaff..abd4819 100644
--- a/cpukit/score/include/rtems/score/schedulerpriority.h
+++ b/cpukit/score/include/rtems/score/schedulerpriority.h
@@ -161,7 +161,7 @@ void _Scheduler_priority_Unblock(
* + ready chain
* + select heir
*
- * @param[in/out] thread The yielding thread.
+ * @param[in,out] thread The yielding thread.
*/
void _Scheduler_priority_Yield( Thread_Control *thread );
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index 0cdc8fc..17514cc 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -82,7 +82,7 @@ void _Scheduler_simple_Schedule( void );
* the timeslice counter is reset. The heir THREAD will be updated if the
* running is also the currently the heir.
*
- * @param[in/out] thread The yielding thread.
+ * @param[in,out] thread The yielding thread.
*/
void _Scheduler_simple_Yield( Thread_Control *thread );
diff --git a/cpukit/score/include/rtems/score/smplock.h b/cpukit/score/include/rtems/score/smplock.h
index d444d18..2f12fdd 100644
--- a/cpukit/score/include/rtems/score/smplock.h
+++ b/cpukit/score/include/rtems/score/smplock.h
@@ -83,7 +83,7 @@ static inline void _SMP_lock_Initialize( SMP_lock_Control *lock )
* current thread of execution is not interrupted indefinite once it obtained
* the SMP lock.
*
- * @param[in/out] lock The SMP lock control.
+ * @param[in,out] lock The SMP lock control.
*/
static inline void _SMP_lock_Acquire( SMP_lock_Control *lock )
{
@@ -93,7 +93,7 @@ static inline void _SMP_lock_Acquire( SMP_lock_Control *lock )
/**
* @brief Releases a SMP lock.
*
- * @param[in/out] lock The SMP lock control.
+ * @param[in,out] lock The SMP lock control.
*/
static inline void _SMP_lock_Release( SMP_lock_Control *lock )
{
@@ -103,7 +103,7 @@ static inline void _SMP_lock_Release( SMP_lock_Control *lock )
/**
* @brief Disables interrupts and acquires the SMP lock.
*
- * @param[in/out] lock The SMP lock control.
+ * @param[in,out] lock The SMP lock control.
* @param[out] isr_cookie The ISR cookie.
*/
#define _SMP_lock_ISR_disable_and_acquire( lock, isr_cookie ) \
@@ -112,7 +112,7 @@ static inline void _SMP_lock_Release( SMP_lock_Control *lock )
/**
* @brief Releases the SMP lock and enables interrupts.
*
- * @param[in/out] lock The SMP lock control.
+ * @param[in,out] lock The SMP lock control.
* @param[in] isr_cookie The ISR cookie.
*/
#define _SMP_lock_Release_and_ISR_enable( lock, isr_cookie ) \
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index 56b9b0c..13b7e75 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -599,7 +599,7 @@ bool _Thread_Initialize(
* @param entry_point
* @param pointer_argument
* @param numeric_argument
- * @param[in/out] processor The processor if used to start an idle thread
+ * @param[in,out] processor The processor if used to start an idle thread
* during system initialization. Must be set to @c NULL to start a normal
* thread.
*/
diff --git a/cpukit/score/inline/rtems/score/chain.inl b/cpukit/score/inline/rtems/score/chain.inl
index 190eedf..3c33669 100644
--- a/cpukit/score/inline/rtems/score/chain.inl
+++ b/cpukit/score/inline/rtems/score/chain.inl
@@ -747,8 +747,8 @@ typedef bool ( *Chain_Node_order )(
* relation holds for all nodes from the head up to the inserted node. Nodes
* after the inserted node are not moved.
*
- * @param[in/out] chain The chain.
- * @param[in/out] to_insert The node to insert.
+ * @param[in,out] chain The chain.
+ * @param[in,out] to_insert The node to insert.
* @param[in] order The order relation.
*/
RTEMS_INLINE_ROUTINE void _Chain_Insert_ordered_unprotected(
diff --git a/cpukit/score/inline/rtems/score/scheduler.inl b/cpukit/score/inline/rtems/score/scheduler.inl
index dc5bdcc..67d8327 100644
--- a/cpukit/score/inline/rtems/score/scheduler.inl
+++ b/cpukit/score/inline/rtems/score/scheduler.inl
@@ -213,8 +213,8 @@ RTEMS_INLINE_ROUTINE void _Scheduler_Tick( void )
/**
* @brief Starts the idle thread for a particular processor.
*
- * @param[in/out] thread The idle thread for the processor.
- * @parma[in/out] processor The processor for the idle thread.
+ * @param[in,out] thread The idle thread for the processor.
+ * @parma[in,out] processor The processor for the idle thread.
*
* @see _Thread_Create_idle().
*/
More information about the vc
mailing list