Changeset a7e4de2 in rtems


Ignore:
Timestamp:
Mar 6, 2015, 8:33:08 PM (5 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
8f49dda
Parents:
325a61d5
Message:

Fix even more Doxygen issues

Location:
cpukit
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libcsupport/include/rtems/error.h

    r325a61d5 ra7e4de2  
    114114 *  @param[in] printf_format is a normal printf(3) format string,
    115115 *  with its concommitant arguments
    116  *  @param[in] @p arglist is a varargs list corresponding to
     116 *  @param[in] arglist is a varargs list corresponding to
    117117 *  printf_format
    118118 *
  • cpukit/sapi/include/rtems/counter.h

    r325a61d5 ra7e4de2  
    124124 * system initialization by the board support package.
    125125 *
    126  * @param[in] uint32_t frequency The current counter frequency in Hz.
     126 * @param[in] frequency The current counter frequency in Hz.
    127127 */
    128128void rtems_counter_initialize_converter( uint32_t frequency );
  • cpukit/score/include/rtems/score/cpusetimpl.h

    r325a61d5 ra7e4de2  
    5252 * @param[in] description is a string to print before the value.
    5353 * @param[in] cpuset is the cpuset to validate
    54  * @param[in] setsize is the number of CPUs in the cpuset
    5554 */
    5655void _CPU_set_Show( const char *description, const cpu_set_t  *cpuset);
  • cpukit/score/include/rtems/score/scheduler.h

    r325a61d5 ra7e4de2  
    489489 *
    490490 * @param[in] scheduler The scheduler.
    491  * @param[in] execution An executing thread.
     491 * @param[in] executing An executing thread.
    492492 */
    493493void _Scheduler_default_Tick(
     
    513513   * @brief Get affinity for the default scheduler.
    514514   *
     515   * @param[in] scheduler The scheduler instance.
    515516   * @param[in] thread The associated thread.
    516517   * @param[in] cpusetsize The size of the cpuset.
     
    530531   * @brief Set affinity for the default scheduler.
    531532   *
     533   * @param[in] scheduler The scheduler instance.
    532534   * @param[in] thread The associated thread.
    533535   * @param[in] cpusetsize The size of the cpuset.
  • cpukit/score/include/rtems/score/schedulercbs.h

    r325a61d5 ra7e4de2  
    151151 *  new job in order to protect concurrent threads.
    152152 *
     153 *  @param[in] scheduler The scheduler instance.
    153154 *  @param[in] the_thread will be unblocked.
    154155 *
     
    167168 *  of new period. Deadline has to be shifted and budget replenished.
    168169 *
     170 *  @param[in] scheduler The scheduler instance.
    169171 *  @param[in] the_thread is the owner of the job.
    170172 *  @param[in] length of the new job from now. If equal to 0,
  • cpukit/score/include/rtems/score/scheduleredf.h

    r325a61d5 ra7e4de2  
    115115
    116116/**
    117  * @brief Initialize EDF scheduler.
    118  *
    119  * This routine initializes the EDF scheduler.
     117 *  @brief Initialize EDF scheduler.
     118 *
     119 *  This routine initializes the EDF scheduler.
     120 *
     121 *  @param[in] scheduler The scheduler instance.
    120122 */
    121123void _Scheduler_EDF_Initialize( const Scheduler_Control *scheduler );
     
    129131 *  a new heir thread.
    130132 *
     133 *  @param[in] scheduler The scheduler instance.
    131134 *  @param[in] the_thread is the thread to be blocked.
    132135 */
     
    142145 *  This kernel routine sets the heir thread to be the next ready thread
    143146 *  in the rbtree ready queue.
     147 *
     148 *  @param[in] scheduler The scheduler instance.
     149 *  @param[in] the_thread being scheduled.
    144150 */
    145151void _Scheduler_EDF_Schedule(
     
    150156/**
    151157 *  @brief Initializes an EDF specific scheduler node of @a the_thread.
     158 *
     159 *  @param[in] scheduler The scheduler instance.
     160 *  @param[in] the_thread being initialized.
    152161 */
    153162void _Scheduler_EDF_Node_initialize(
     
    161170 *  This routine updates position in the ready queue of @a the_thread.
    162171 *
     172 *  @param[in] scheduler The scheduler instance.
    163173 *  @param[in] the_thread will have its scheduler specific information
    164174 *             structure updated.
     175 *  @param[in] new_priority is the desired new priority.
    165176 */
    166177void _Scheduler_EDF_Update_priority(
     
    177188 *  variables, for example the heir thread.
    178189 *
     190 *  @param[in] scheduler The scheduler instance.
    179191 *  @param[in] the_thread will be unblocked.
    180192 */
     
    204216 *  in such a case.
    205217 *
    206  *  @param[in,out] thread The yielding thread.
     218 *  @param[in] scheduler The scheduler instance.
     219 *  @param[in,out] the_thread The yielding thread.
    207220 */
    208221Scheduler_Void_or_thread _Scheduler_EDF_Yield(
     
    231244 *  of new period.
    232245 *
     246 *  @param[in] scheduler The scheduler instance.
    233247 *  @param[in] the_thread is the owner of the job.
    234248 *  @param[in] deadline of the new job from now. If equal to 0,
  • cpukit/score/include/rtems/score/schedulerimpl.h

    r325a61d5 ra7e4de2  
    472472 * @brief Starts the idle thread for a particular processor.
    473473 *
     474 * @param[in] scheduler The scheduler instance.
    474475 * @param[in,out] the_thread The idle thread for the processor.
    475  * @parma[in,out] processor The processor for the idle thread.
     476 * @param[in,out] cpu The processor for the idle thread.
    476477 *
    477478 * @see _Thread_Create_idle().
  • cpukit/score/include/rtems/score/schedulerpriority.h

    r325a61d5 ra7e4de2  
    114114 *  a new heir thread.
    115115 *
     116 *  @param[in] scheduler The scheduler instance.
    116117 *  @param[in] the_thread is the thread to be blocked
    117118 */
     
    149150 *  updates any appropriate scheduling variables, for example the heir thread.
    150151 *
     152 *  @param[in] scheduler The scheduler instance.
    151153 *  @param[in] the_thread will be unblocked
    152154 */
     
    180182 *    + select heir
    181183 *
    182  *  @param[in,out] thread The yielding thread.
     184 *  @param[in] scheduler The scheduler instance.
     185 *  @param[in,out] the_thread The yielding thread.
    183186 */
    184187Scheduler_Void_or_thread _Scheduler_priority_Yield(
     
    191194 *
    192195 *  This routine compares two priorities.
     196 *
     197 * @retval >0 for p1 > p2; 0 for p1 == p2; <0 for p1 < p2.
    193198 */
    194199int _Scheduler_priority_Priority_compare(
  • cpukit/score/include/rtems/score/schedulerpriorityaffinitysmp.h

    r325a61d5 ra7e4de2  
    130130 *
    131131 * @param[in] scheduler The scheduler of the thread.
    132  * @param[in] thread The associated thread.
     132 * @param[in] the_thread The associated thread.
    133133 * @param[in] new_priority The new priority for the thread.
    134134 * @param[in] prepend_it Append or prepend the thread to its priority FIFO.
  • cpukit/score/include/rtems/score/schedulersimple.h

    r325a61d5 ra7e4de2  
    8181 *  on the ready queue by getting the first node in the scheduler
    8282 *  information.
     83 *
     84 *  @param[in] scheduler The scheduler instance.
     85 *  @param[in] the_thread causing the scheduling operation.
    8386 */
    8487void _Scheduler_simple_Schedule(
     
    101104 *  running is also the currently the heir.
    102105 *
    103  *  @param[in,out] thread The yielding thread.
     106 *  @param[in] scheduler The scheduler instance.
     107 *  @param[in,out] the_thread The yielding thread.
    104108 */
    105109Scheduler_Void_or_thread _Scheduler_simple_Yield(
     
    116120 *  a new heir thread.
    117121 *
     122 *  @param[in] scheduler The scheduler instance.
    118123 *  @param[in] the_thread is the thread that is to be blocked
    119124 */
     
    130135 *  updates any appropriate scheduling variables, for example the heir thread.
    131136 *
     137 *  @param[in] scheduler The scheduler instance.
    132138 *  @param[in] the_thread is the thread that is to be unblocked
    133139 */
  • cpukit/score/include/rtems/score/threadimpl.h

    r325a61d5 ra7e4de2  
    117117 *
    118118 *  @param[in] the_thread is the thread where the stack space is requested
     119 *  @param[in] stack_size is the stack space is requested
    119120 *
    120121 *  @retval actual size allocated after any adjustment
     
    323324 *
    324325 *  @param[in] id is the thread id
     326 *  @param[in] ignored is not used
    325327 */
    326328void _Thread_Delay_ended(
Note: See TracChangeset for help on using the changeset viewer.