Changeset a0e6c73 in rtems


Ignore:
Timestamp:
Dec 14, 2012, 1:51:15 AM (8 years ago)
Author:
Mathew Kallada <matkallada@…>
Branches:
4.11, 5, master
Children:
074fafd, 6d5ba49
Parents:
41b590f9
git-author:
Mathew Kallada <matkallada@…> (12/14/12 01:51:15)
git-committer:
Gedare Bloom <gedare@…> (12/14/12 01:51:15)
Message:

posix: Doxygen enhancement task #4

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

Location:
cpukit/posix
Files:
27 edited

Legend:

Unmodified
Added
Removed
  • cpukit/posix/include/mqueue.h

    r41b590f9 ra0e6c73  
    2626#include <rtems/system.h>
    2727#include <rtems/score/object.h>
     28
     29/**
     30 *  @defgroup POSIX_MQUEUE Message Queues
     31 *
     32 *  @ingroup POSIX
     33 */
     34/**@{*/
    2835
    2936#ifdef __cplusplus
     
    7380
    7481/**
     82 *  @brief Remove a Message Queue
     83 *
    7584 *  15.2.2 Remove a Message Queue, P1003.1b-1993, p. 276
     85 *
     86 *  NOTE:  The structure of the routines is identical to that of POSIX
     87 *         Message_queues to leave the option of having unnamed message
     88 *         queues at a future date.  They are currently not part of the
     89 *         POSIX standard but unnamed message_queues are.  This is also
     90 *         the reason for the apparently unnecessary tracking of
     91 *         the process_shared attribute.  [In addition to the fact that
     92 *         it would be trivial to add pshared to the mq_attr structure
     93 *         and have process private message queues.]
     94 *
     95 *         This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open
     96 *         time.
    7697 */
    7798int mq_unlink(
     
    168189
    169190#endif /* _POSIX_MESSAGE_PASSING */
    170 
     191/**@}*/
    171192#endif
    172193/* end of include file */
  • cpukit/posix/include/rtems/posix/cond.h

    r41b590f9 ra0e6c73  
    1818#define _RTEMS_POSIX_COND_H
    1919
     20/**
     21 *  @defgroup POSIX_COND_VARS Condition Variables
     22 *
     23 *  @ingroup POSIX
     24 */
     25/**@{*/
    2026#ifdef __cplusplus
    2127extern "C" {
     
    5763
    5864/*
     65 * @brief Initialization Necessary for this Manager
     66 *
    5967 *  _POSIX_Condition_variables_Manager_initialization
    6068 *
     
    126134
    127135/*
     136 * @brief Implements wake up version of the "signal" operation
     137 *
    128138 *  _POSIX_Condition_variables_Signal_support
    129139 *
     
    175185}
    176186#endif
    177 
     187/**@}*/
    178188#endif
    179189/*  end of include file */
  • cpukit/posix/include/rtems/posix/key.h

    r41b590f9 ra0e6c73  
    2020#include <rtems/score/object.h>
    2121
     22/**
     23 *  @defgroup POSIX_KEY Key
     24 *
     25 *  @ingroup POSIX
     26 */
     27/**@{*/
    2228#ifdef __cplusplus
    2329extern "C" {
     
    4652
    4753/**
    48  *  @brief _POSIX_Keys_Manager_initialization
     54 *  @brief POSIX Keys Manager Initialization
    4955 *
    5056 *  This routine performs the initialization necessary for this manager.
     
    96102}
    97103#endif
    98 
     104/**@}*/
    99105#endif
    100106/*  end of include file */
  • cpukit/posix/include/rtems/posix/ptimer.h

    r41b590f9 ra0e6c73  
    2121#define _RTEMS_POSIX_PTIMER_H
    2222
     23/**
     24 *  @defgroup POSIX_PRIV_TIMERS Timers
     25 *
     26 *  @ingroup POSIX
     27 */
     28/**@{*/
    2329#ifdef __cplusplus
    2430extern "C" {
     
    3844
    3945/*
     46 *  @brief Create a Per-Process Timer
     47 *
    4048 *  14.2.2 Create a Per-Process Timer, P1003.1b-1993, p. 264
    4149 *
     
    9199  timer_t   timerid
    92100);
    93 
     101/**@}*/
    94102#endif
  • cpukit/posix/include/rtems/posix/threadsup.h

    r41b590f9 ra0e6c73  
    2121#include <rtems/score/tqdata.h>
    2222
     23/**
     24 *  @defgroup POSIX_THREAD Thread API Extension
     25 *
     26 *  @ingroup POSIX
     27 */
     28/**@{*/
    2329#ifdef __cplusplus
    2430extern "C" {
     
    7682 *  @brief POSIX Thread Exit Shared Helper
    7783 *
     84 *  16.1.5.1 Thread Termination, p1003.1c/Draft 10, p. 150
     85 *
    7886 *  This method is a helper routine which ensures that all
    7987 *  POSIX thread calls which result in a thread exiting will
     
    8290 *  @param[in] the_thread is the thread exiting or being canceled
    8391 *  @param[in] value_ptr is the value to be returned by the thread
     92 *
     93 *  NOTE: Key destructors are executed in the POSIX api delete extension.
     94 *
    8495 */
    8596void _POSIX_Thread_Exit(
     
    91102}
    92103#endif
    93 
     104/**@}*/
    94105#endif
    95106/* end of include file */
  • cpukit/posix/include/rtems/posix/time.h

    r41b590f9 ra0e6c73  
    2020#include <rtems/score/timespec.h>
    2121#include <rtems/score/watchdog.h>
     22/**
     23 *  @defgroup POSIX_TIMETYPES Time Types
     24 *
     25 *  @ingroup POSIX
     26 */
     27/**@{*/
    2228
    2329/**
     
    6066
    6167#endif
     68/**@}*/
  • cpukit/posix/include/rtems/posix/timer.h

    r41b590f9 ra0e6c73  
    2222#include <rtems/score/watchdog.h> /* Watchdog_Control */
    2323
     24/**
     25 *  @defgroup POSIX_INTERNAL_TIMERS Timers
     26 *
     27 *  @ingroup POSIX
     28 */
     29/**@{*/
    2430#ifdef __cplusplus
    2531extern "C" {
     
    7682
    7783/*
     84 *  @brief Operation that is run when a timer expires
     85 *
    7886 *  Timer TSR
    7987 */
     
    104112}
    105113#endif
    106 
     114/**@}*/
    107115#endif
    108116/* end of include file */
  • cpukit/posix/src/barrierattrgetpshared.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Barrier Attributes Get Process Shared
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2007.
  • cpukit/posix/src/cleanuppush.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Establishing Cancellation Handlers
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2008.
  • cpukit/posix/src/clocksettime.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Set Time of Clock
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2007.
  • cpukit/posix/src/cond.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Initialization Necessary for this Manager
     5 * @ingroup POSIX_COND_VARS Condition Variables
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2008.
  • cpukit/posix/src/condsignalsupp.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Implements wake up version of the "signal" operation
     5 * @ingroup POSIX_COND_VARS Condition Variables
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2007.
  • cpukit/posix/src/condtimedwait.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Waiting on a Condition
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2008.
  • cpukit/posix/src/key.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief POSIX Keys Manager Initialization
     5 * @ingroup POSIX_KEY Key
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2008.
  • cpukit/posix/src/mprotect.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Change Memory Protection
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2007.
  • cpukit/posix/src/mqueueunlink.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Remove a Message Queue
     5 * @ingroup POSIX_MQUEUE Message Queues
     6 */
     7
    18/*
    2  *  NOTE:  The structure of the routines is identical to that of POSIX
    3  *         Message_queues to leave the option of having unnamed message
    4  *         queues at a future date.  They are currently not part of the
    5  *         POSIX standard but unnamed message_queues are.  This is also
    6  *         the reason for the apparently unnecessary tracking of
    7  *         the process_shared attribute.  [In addition to the fact that
    8  *         it would be trivial to add pshared to the mq_attr structure
    9  *         and have process private message queues.]
    10  *
    11  *         This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open
    12  *         time.
    13  *
    149 *  COPYRIGHT (c) 1989-2007.
    1510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/posix/src/mutexattrgetprioceiling.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Mutex Initialization Scheduling Attributes
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2007.
  • cpukit/posix/src/posixtimespecabsolutetimeout.c

    r41b590f9 ra0e6c73  
    1 /*
    2  *  Convert abstime timeout to ticks
     1/**
     2 * @file
     3 *
     4 * @brief Convert Absolute Timeout to Ticks
     5 * @ingroup POSIX_TIMETYPES Time Types
    36 */
    47
  • cpukit/posix/src/prwlocktrywrlock.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Attempt to Obtain a Write Lock on a RWLock Instance
     5 * @ingroup POSIX
     6 */
     7
    18/*
    2  *  POSIX RWLock Manager -- Attempt to Obtain a Write Lock on a RWLock Instance
    3  *
    49 *  COPYRIGHT (c) 1989-2007.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/posix/src/pspintrylock.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Wait at a Spinlock
     5 * @ingroup POSIX
     6 */
     7
    18/*
    2  *  POSIX Spinlock Manager -- Wait at a Spinlock
    3  *
    49 *  COPYRIGHT (c) 1989-2007.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/posix/src/pthreadexit.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief POSIX Thread Exit Shared Helper
     5 * @ingroup POSIX_THREAD Thread API Extension
     6 */
     7
    18/*
    2  *  16.1.5.1 Thread Termination, p1003.1c/Draft 10, p. 150
    3  *
    4  *  NOTE: Key destructors are executed in the POSIX api delete extension.
    5  *
    69 *  COPYRIGHT (c) 1989-2011.
    710 *  On-Line Applications Research Corporation (OAR).
  • cpukit/posix/src/setcancelstate.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Setting Cancelability State
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2009.
  • cpukit/posix/src/sigemptyset.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Manipulate Signal Sets
     5 * @ingroup POSIX
     6 */
     7
    18/*
    2  *  3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69
    3  *
    49 *  COPYRIGHT (c) 1989-1999.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/posix/src/sigpending.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Examine Pending Signals
     5 * @ingroup POSIX
     6 */
     7
    18/*
    2  *  3.3.6 Examine Pending Signals, P1003.1b-1993, p. 75
    3  *
    49 *  COPYRIGHT (c) 1989-1999.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/posix/src/sysconf.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Get Configurable System Variables
     5 * @ingroup POSIX
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2007.
  • cpukit/posix/src/timercreate.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Create a Per-Process Timer
     5 * @ingroup POSIX_PRIV_TIMERS Timers
     6 */
     7
    18/*
    29 *  14.2.2 Create a Per-Process Timer, P1003.1b-1993, p. 264
  • cpukit/posix/src/timertsr.c

    r41b590f9 ra0e6c73  
     1/**
     2 * @file
     3 *
     4 * @brief Operation that is run when a timer expires
     5 * @ingroup POSIX_INTERNAL_TIMERS Timers
     6 */
     7
    18/*
    29 * _POSIX_Timer_TSR
Note: See TracChangeset for help on using the changeset viewer.