Changeset 961669d in rtems


Ignore:
Timestamp:
Jun 14, 2013, 1:30:37 PM (6 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
9f868a16
Parents:
8b222be
git-author:
Sebastian Huber <sebastian.huber@…> (06/14/13 13:30:37)
git-committer:
Sebastian Huber <sebastian.huber@…> (06/14/13 14:26:09)
Message:

documentation: Fix Doxygen comments

Location:
cpukit
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libfs/src/dosfs/dosfs.h

    r8b222be r961669d  
    3434 * @brief Converts from UTF-8 into a specific code page.
    3535 *
    36  * @param[in/out] self The convert control.
     36 * @param[in,out] self The convert control.
    3737 * @param[in] src A well-formed UTF-8 string to be converted.
    3838 * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
    3939 * @param[out] dst The address the converted string will get copied to.
    40  * @param[in/out] dst_size The size of the buffer in bytes respectively the
     40 * @param[in,out] dst_size The size of the buffer in bytes respectively the
    4141 * number of bytes written to the buffer.
    4242 *
     
    5656 * @brief Converts from a specific code page into UTF-8
    5757 *
    58  * @param[in/out] self The convert control.
     58 * @param[in,out] self The convert control.
    5959 * @param[in] src A well-formed string in code page format.
    6060 * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
    6161 * @param[out] dst The address the converted string will get copied to.
    62  * @param[in/out] dst_size The size of the buffer in bytes respectively the
     62 * @param[in,out] dst_size The size of the buffer in bytes respectively the
    6363 * number of bytes written to the buffer.
    6464 *
     
    7878 * @brief Converts from UTF-8 to UTF-16
    7979 *
    80  * @param[in/out] self The convert control.
     80 * @param[in,out] self The convert control.
    8181 * @param[in] src A well-formed UTF-8 string to be converted.
    8282 * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
    8383 * @param[out] dst The address the converted string will get copied to
    84  * @param[in/out] dst_size The size of the buffer in bytes respectively the
     84 * @param[in,out] dst_size The size of the buffer in bytes respectively the
    8585 * number of bytes written to the buffer.
    8686 *
     
    100100 * @brief Converts from UTF-16 to UTF-8.
    101101 *
    102  * @param[in/out] self The convert control.
     102 * @param[in,out] self The convert control.
    103103 * @param[in] src A well-formed UTF-16 string to be converted.
    104104 * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
    105105 * @param[out] dst The address the converted string will get copied to.
    106  * @param[in/out] dst_size The size of the buffer in bytes respectively the
     106 * @param[in,out] dst_size The size of the buffer in bytes respectively the
    107107 * number of bytes written to the buffer
    108108 *
     
    125125 * also converts upper case alphabetic characters to lower case characters
    126126 *
    127  * @param[in/out] self The convert control.
     127 * @param[in,out] self The convert control.
    128128 * @param[in] src A well-formed UTF-8 string to be normalized and fold.
    129129 * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
    130130 * @param[out] dst The address the normalized and fold string will get
    131131 * copied to.
    132  * @param[in/out] dst_size The size of the buffer in bytes respectively the
     132 * @param[in,out] dst_size The size of the buffer in bytes respectively the
    133133 * number of bytes written to the buffer.
    134134 *
     
    150150 * @brief Destroys a convert control structure.
    151151 *
    152  * @param[in/out] self The convert control for destruction.
     152 * @param[in,out] self The convert control for destruction.
    153153 */
    154154typedef void (*rtems_dosfs_convert_destroy)(
  • cpukit/score/cpu/no_cpu/rtems/score/cpusmplock.h

    r8b222be r961669d  
    6161 * @brief Acquires a CPU SMP lock.
    6262 *
    63  * @param[in/out] lock The CPU SMP lock control.
     63 * @param[in,out] lock The CPU SMP lock control.
    6464 */
    6565static inline void _CPU_SMP_lock_Acquire( CPU_SMP_lock_Control *lock )
     
    7575 * @brief Releases a CPU SMP lock.
    7676 *
    77  * @param[in/out] lock The CPU SMP lock control.
     77 * @param[in,out] lock The CPU SMP lock control.
    7878 */
    7979static inline void _CPU_SMP_lock_Release( CPU_SMP_lock_Control *lock )
     
    8585 * @brief Disables interrupts and acquires the CPU SMP lock.
    8686 *
    87  * @param[in/out] lock The CPU SMP lock control.
     87 * @param[in,out] lock The CPU SMP lock control.
    8888 * @param[out] isr_cookie The ISR cookie.
    8989 */
     
    9797 * @brief Releases the CPU SMP lock and enables interrupts.
    9898 *
    99  * @param[in/out] lock The CPU SMP lock control.
     99 * @param[in,out] lock The CPU SMP lock control.
    100100 * @param[in] isr_cookie The ISR cookie.
    101101 */
  • cpukit/score/include/rtems/score/scheduler.h

    r8b222be r961669d  
    161161 * @brief Unblocks the thread.
    162162 *
    163  * @param[in/out] thread An idle thread.
     163 * @param[in,out] thread An idle thread.
    164164 * @param[in] processor This parameter is unused.
    165165 */
  • cpukit/score/include/rtems/score/scheduleredf.h

    r8b222be r961669d  
    194194 *  in such a case.
    195195 *
    196  *  @param[in/out] thread The yielding thread.
     196 *  @param[in,out] thread The yielding thread.
    197197 */
    198198void _Scheduler_EDF_Yield( Thread_Control *thread );
  • cpukit/score/include/rtems/score/schedulerpriority.h

    r8b222be r961669d  
    162162 *    + select heir
    163163 *
    164  *  @param[in/out] thread The yielding thread.
     164 *  @param[in,out] thread The yielding thread.
    165165 */
    166166void _Scheduler_priority_Yield( Thread_Control *thread );
  • cpukit/score/include/rtems/score/schedulersimple.h

    r8b222be r961669d  
    8383 *  running is also the currently the heir.
    8484 *
    85  *  @param[in/out] thread The yielding thread.
     85 *  @param[in,out] thread The yielding thread.
    8686 */
    8787void _Scheduler_simple_Yield( Thread_Control *thread );
  • cpukit/score/include/rtems/score/smplock.h

    r8b222be r961669d  
    8484 * the SMP lock.
    8585 *
    86  * @param[in/out] lock The SMP lock control.
     86 * @param[in,out] lock The SMP lock control.
    8787 */
    8888static inline void _SMP_lock_Acquire( SMP_lock_Control *lock )
     
    9494 * @brief Releases a SMP lock.
    9595 *
    96  * @param[in/out] lock The SMP lock control.
     96 * @param[in,out] lock The SMP lock control.
    9797 */
    9898static inline void _SMP_lock_Release( SMP_lock_Control *lock )
     
    104104 * @brief Disables interrupts and acquires the SMP lock.
    105105 *
    106  * @param[in/out] lock The SMP lock control.
     106 * @param[in,out] lock The SMP lock control.
    107107 * @param[out] isr_cookie The ISR cookie.
    108108 */
     
    113113 * @brief Releases the SMP lock and enables interrupts.
    114114 *
    115  * @param[in/out] lock The SMP lock control.
     115 * @param[in,out] lock The SMP lock control.
    116116 * @param[in] isr_cookie The ISR cookie.
    117117 */
  • cpukit/score/include/rtems/score/thread.h

    r8b222be r961669d  
    600600 *  @param pointer_argument
    601601 *  @param numeric_argument
    602  *  @param[in/out] processor The processor if used to start an idle thread
     602 *  @param[in,out] processor The processor if used to start an idle thread
    603603 *  during system initialization.  Must be set to @c NULL to start a normal
    604604 *  thread.
  • cpukit/score/inline/rtems/score/chain.inl

    r8b222be r961669d  
    748748 * after the inserted node are not moved.
    749749 *
    750  * @param[in/out] chain The chain.
    751  * @param[in/out] to_insert The node to insert.
     750 * @param[in,out] chain The chain.
     751 * @param[in,out] to_insert The node to insert.
    752752 * @param[in] order The order relation.
    753753 */
  • cpukit/score/inline/rtems/score/scheduler.inl

    r8b222be r961669d  
    214214 * @brief Starts the idle thread for a particular processor.
    215215 *
    216  * @param[in/out] thread The idle thread for the processor.
    217  * @parma[in/out] processor The processor for the idle thread.
     216 * @param[in,out] thread The idle thread for the processor.
     217 * @parma[in,out] processor The processor for the idle thread.
    218218 *
    219219 * @see _Thread_Create_idle().
Note: See TracChangeset for help on using the changeset viewer.