Changeset 355ee7d in rtems


Ignore:
Timestamp:
Nov 28, 2012, 7:57:31 PM (7 years ago)
Author:
Alex Ivanov <alexivanov97@…>
Branches:
4.11, master
Children:
bf54252
Parents:
d4d7899
git-author:
Alex Ivanov <alexivanov97@…> (11/28/12 19:57:31)
git-committer:
Joel Sherrill <joel.sherrill@…> (11/28/12 19:57:31)
Message:

score misc: Clean up Doxygen #3 (GCI 2012)

This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.

http://www.google-melange.com/gci/task/view/google/gci2012/7982215

Location:
cpukit/score
Files:
26 edited

Legend:

Unmodified
Added
Removed
  • cpukit/score/include/rtems/score/coremsg.h

    rd4d7899 r355ee7d  
    258258/**
    259259 *  @brief Initialize a Message Queue
    260  *
    261  *  This routine initializes @a the_message_queue based on the parameters passed.
     260 *
     261 *  DESCRIPTION:
     262 *
     263 *  This package is the implementation of the CORE Message Queue Handler.
     264 *  This core object provides task synchronization and communication functions
     265 *  via messages passed to queue objects.
     266 *
     267 *  This routine initializes @a the_message_queue
     268 *      based on the parameters passed.
    262269 *
    263270 *  @param[in] the_message_queue points to the message queue to initialize
  • cpukit/score/include/rtems/score/coresem.h

    rd4d7899 r355ee7d  
    128128
    129129/**
     130 *  @brief Core Semaphore Initialize
     131 *
     132 *  DESCRIPTION:
     133 *
     134 *  This package is the implementation of the CORE Semaphore Handler.
     135 *  This core object utilizes standard Dijkstra counting semaphores to provide
     136 *  synchronization and mutual exclusion capabilities.
     137 *
    130138 *  This routine initializes the semaphore based on the parameters passed.
    131139 *
  • cpukit/score/include/rtems/score/object.h

    rd4d7899 r355ee7d  
    698698
    699699/**
     700 *  @brief  Get No protection Object
     701 *
    700702 *  This function maps object ids to object control blocks.
    701703 *  If id corresponds to a local object, then it returns
  • cpukit/score/include/rtems/score/schedulerpriority.h

    rd4d7899 r355ee7d  
    122122
    123123/**
     124 *  @brief Scheduler Priority Unblock
     125 *
    124126 *  This routine adds @a the_thread to the scheduling decision,
    125127 *  that is, adds it to the ready queue and
  • cpukit/score/include/rtems/score/schedulersimple.h

    rd4d7899 r355ee7d  
    120120
    121121/**
     122 *  @brief Scheduler simple Enqueue first
     123 * 
    122124 *  This routine puts @a the_thread to the head of the ready queue.
    123125 *  The thread will be the first thread at its priority level.
  • cpukit/score/include/rtems/score/thread.h

    rd4d7899 r355ee7d  
    709709
    710710/**
     711 *  @brief Set Thread Priority
     712 * 
    711713 *  This routine updates the priority related fields in the_thread
    712714 *  control block to indicate the current priority is now new_priority.
  • cpukit/score/include/rtems/score/threadq.h

    rd4d7899 r355ee7d  
    110110 *  its new priority.  This method has no impact on the state of the_thread
    111111 *  or of any timeouts associated with this blocking.
     112 *
     113 *  @param[in] the_thread_queue pointer to a threadq header
     114 *  @param[in] the_thread pointer to a thread control block
    112115 */
    113116void _Thread_queue_Requeue(
     
    255258 *  the_thread_queue with an optional timeout using the
    256259 *  FIFO discipline.
     260 *
     261 *    @param[in] the_thread_queue pointer to threadq
     262 *    @param[in] the_thread pointer to the thread to block
     263 *    @param[in] level_p interrupt level in case the operation blocks actually
     264 *
     265 *  - INTERRUPT LATENCY:
     266 *    + single case
    257267 */
    258268Thread_blocking_operation_States _Thread_queue_Enqueue_fifo (
  • cpukit/score/src/coremsg.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Initialize a Message Queue
     5 *  @ingroup ScoreMessageQueue
     6 */
     7
    18/*
    2  *  CORE Message Queue Handler
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the CORE Message Queue Handler.
    7  *  This core object provides task synchronization and communication functions
    8  *  via messages passed to queue objects.
    9  *
    109 *  COPYRIGHT (c) 1989-2009.
    1110 *  On-Line Applications Research Corporation (OAR).
     
    4948  return true;
    5049}
    51 
    52 /*
    53  *  _CORE_message_queue_Initialize
    54  *
    55  *  This routine initializes a newly created message queue based on the
    56  *  specified data.
    57  *
    58  *  Input parameters:
    59  *    the_message_queue            - the message queue to initialize
    60  *    the_class                    - the API specific object class
    61  *    the_message_queue_attributes - the message queue's attributes
    62  *    maximum_pending_messages     - maximum message and reserved buffer count
    63  *    maximum_message_size         - maximum size of each message
    64  *
    65  *  Output parameters:
    66  *    true   - if the message queue is initialized
    67  *    false  - if the message queue is NOT initialized
    68  */
    6950
    7051bool _CORE_message_queue_Initialize(
  • cpukit/score/src/coresem.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Core Semaphore Initialize
     5 *  @ingroup ScoreSemaphore
     6 */
     7
    18/*
    2  *  CORE Semaphore Handler
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the CORE Semaphore Handler.
    7  *  This core object utilizes standard Dijkstra counting semaphores to provide
    8  *  synchronization and mutual exclusion capabilities.
    9  *
    109 *  COPYRIGHT (c) 1989-1999.
    1110 *  On-Line Applications Research Corporation (OAR).
     
    2726#include <rtems/score/threadq.h>
    2827
    29 /*
    30  *  CORE_semaphore_Initialize
    31  *
    32  *  This function initialize a semaphore and sets the initial value based
    33  *  on the given count.
    34  *
    35  *  Input parameters:
    36  *    the_semaphore            - the semaphore control block to initialize
    37  *    the_semaphore_attributes - the attributes specified at create time
    38  *    initial_value            - semaphore's initial value
    39  *
    40  *  Output parameters:  NONE
    41  */
    42 
    4328void _CORE_semaphore_Initialize(
    4429  CORE_semaphore_Control       *the_semaphore,
  • cpukit/score/src/coretodget.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Returns a Current TOD with Nanosecond Granularity
     5 *  @ingroup ScoreTODConstants
     6 */
     7
    18/*
    2  *  Time of Day (TOD) Handler - get TOD
    3  *
    49 *  COPYRIGHT (c) 1989-2008.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/coretodtickspersec.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Convert Ticks To Seconds
     5 *  @ingroup ScoreTODConstants
     6 */
     7
    18/*  COPYRIGHT (c) 1989-2008.
    29 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/objectgetnoprotection.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief  Get Object without Dispatching Protection
     5 *  @ingroup ScoreObject
     6 */
     7
    18/*
    2  *  Object Handler -- Object Get
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2002.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2630#include <rtems/score/sysstate.h>
    2731#include <rtems/score/isr.h>
    28 
    29 /*
    30  * _Objects_Get_no_protection
    31  *
    32  * This routine sets the object pointer for the given
    33  * object id based on the given object information structure.
    34  *
    35  * Input parameters:
    36  *   information - pointer to entry in table for this class
    37  *   id          - object id to search for
    38  *   location    - address of where to store the location
    39  *
    40  * Output parameters:
    41  *   returns  - address of object if local
    42  *   location - one of the following:
    43  *                  OBJECTS_ERROR  - invalid object ID
    44  *                  OBJECTS_REMOTE - remote object
    45  *                  OBJECTS_LOCAL  - local object
    46  */
    4732
    4833Objects_Control *_Objects_Get_no_protection(
  • cpukit/score/src/schedulercbscleanup.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler CBS Cleanup
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulercbscreateserver.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler CBS Create Server
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulercbsgetapprovedbudget.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler CBS Get Approved Budget
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulercbsgetremainingbudget.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler CBS Get Remaining Budget
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulerpriorityprioritycompare.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler Priority Compare Two Priorities
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 2011.
  • cpukit/score/src/schedulerpriorityreleasejob.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler Priority Release Job
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulerpriorityunblock.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler Priority Unblock
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Scheduler Handler
  • cpukit/score/src/schedulersimpleenqueuefirst.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler Simple Enqueue First
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    2  *  Schedule Simple Handler / Enqueue First
    3  *
    49 *  COPYRIGHT (c) 2011.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/smplock.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief SMP Locking Support
     5 *  @ingroup RTEMS
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2011.
     
    6875#endif
    6976
    70 /*
    71  * SMP spinlock simple methods
    72  */
    7377void _SMP_lock_spinlock_simple_Initialize(
    7478  SMP_lock_spinlock_simple_Control *lock
     
    106110}
    107111
    108 /*
    109  * SMP spinlock nested methods.
    110  */
    111112void _SMP_lock_spinlock_nested_Initialize(
    112113  SMP_lock_spinlock_nested_Control *lock
  • cpukit/score/src/threadqenqueuefifo.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief  Thread queue Enqueue FIFO
     5 *  @ingroup ScoreThreadQ
     6 */
     7
    18/*
    2  *  Thread Queue Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2327#include <rtems/score/threadq.h>
    2428#include <rtems/score/tqdata.h>
    25 
    26 /*
    27  *  _Thread_queue_Enqueue_fifo
    28  *
    29  *  This routine places a blocked thread on a FIFO thread queue.
    30  *
    31  *  Input parameters:
    32  *    the_thread_queue - pointer to threadq
    33  *    the_thread       - pointer to the thread to block
    34  *
    35  *  Output parameters: NONE
    36  *
    37  *  INTERRUPT LATENCY:
    38  *    only case
    39  */
    4029
    4130Thread_blocking_operation_States _Thread_queue_Enqueue_fifo (
  • cpukit/score/src/threadqrequeue.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Thread Queue Requeue
     5 *  @ingroup ScoreThreadQ
     6 */
     7
    18/*
    2  *  Thread Queue Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2327#include <rtems/score/threadq.h>
    2428#include <rtems/score/tqdata.h>
    25 
    26 /*
    27  *  _Thread_queue_Requeue
    28  *
    29  *  This routine is invoked when a thread changes priority and should be
    30  *  moved to a different position on the thread queue.
    31  *
    32  *  Input parameters:
    33  *    the_thread_queue - pointer to a threadq header
    34  *    the_thread       - pointer to a thread control block
    35  *
    36  *  Output parameters: NONE
    37  *
    38  *  INTERRUPT LATENCY: NONE
    39  */
    4029
    4130void _Thread_queue_Requeue(
  • cpukit/score/src/threadsetpriority.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Set Thread Priority
     5 *  @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  Thread Handler / Thread Set Priority
    3  *
    49 *  COPYRIGHT (c) 1989-2011.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/ts64dividebyinteger.c

    rd4d7899 r355ee7d  
    11/**
    2  * @file score/src/ts64dividebyinteger.c
    3 */
     2 *  @file
     3 *
     4 *  @brief Divide Timestamp By Integer
     5 *  @ingroup SuperCore
     6 */
    47
    58/*
  • cpukit/score/src/watchdogadjust.c

    rd4d7899 r355ee7d  
     1/**
     2 *  @file
     3 *
     4 *  @brief Watchdog Adjust
     5 *  @ingroup ScoreWatchdog
     6 */
     7
    18/*
    2  *  Watchdog Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    1822#include <rtems/score/isr.h>
    1923#include <rtems/score/watchdog.h>
    20 
    21 /*
    22  *  _Watchdog_Adjust
    23  *
    24  *  This routine adjusts the delta chain backward or forward in response
    25  *  to a time change.
    26  *
    27  *  Input parameters:
    28  *    header    - pointer to the delta chain to be adjusted
    29  *    direction - forward or backward adjustment to delta chain
    30  *    units     - units to adjust
    31  *
    32  *  Output parameters:
    33  */
    3424
    3525void _Watchdog_Adjust(
Note: See TracChangeset for help on using the changeset viewer.