Changeset 9ab091e in rtems


Ignore:
Timestamp:
Dec 28, 2012, 4:35:32 PM (7 years ago)
Author:
Mathew Kallada <matkallada@…>
Branches:
4.11, master
Children:
1ccbfe2d
Parents:
f11858ac
git-author:
Mathew Kallada <matkallada@…> (12/28/12 16:35:32)
git-committer:
Jennifer Averett <jennifer.averett@…> (12/28/12 16:36:55)
Message:

Header File Doxygen Enhancement Task #2

Location:
cpukit
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/bspIo.h

    rf11858ac r9ab091e  
    11/**
    22 * @file rtems/bspIo.h
     3 *
     4 * @brief Interface to Kernel Print Methods
    35 *
    46 * This include file defines the interface to kernel print methods.
  • cpukit/libblock/include/rtems/bdpart.h

    rf11858ac r9ab091e  
    44 * @ingroup rtems_bdpart
    55 *
    6  * Block device partition management.
     6 * @brief Block Device Partition Management
    77 */
    88
  • cpukit/libblock/include/rtems/blkdev.h

    rf11858ac r9ab091e  
    44 * @ingroup rtems_blkdev
    55 *
    6  * Block device management.
     6 * @brief Block Device Management
    77 */
    88
  • cpukit/libblock/include/rtems/diskdevs.h

    rf11858ac r9ab091e  
    22 * @file
    33 *
     4 * @brief Block Device Disk Management API
     5 *
    46 * @ingroup rtems_disk
    5  *
    6  * @brief Block device disk management API.
    77 */
    88
     
    9595  /**
    9696   * @brief Read hit count.
    97    * 
     97   *
    9898   * A read hit occurs in the rtems_bdbuf_read() function in case the block is
    9999   * in the cached or modified state.
     
    103103  /**
    104104   * @brief Read miss count.
    105    * 
     105   *
    106106   * A read miss occurs in the rtems_bdbuf_read() function in case the block is
    107107   * in the empty state and a read transfer must be initiated to read the data
  • cpukit/libblock/include/rtems/flashdisk.h

    rf11858ac r9ab091e  
    33 *
    44 * @ingroup RTEMSFDisk
     5 *
     6 * @brief Interface to a Flash Disk Block Device
    57 *
    68 * This file defines the interface to a flash disk block device.
  • cpukit/libcsupport/include/clockdrv.h

    rf11858ac r9ab091e  
    11/**
    22 * @file rtems/clockdrv.h
     3 *
     4 * @brief Clock Driver for all Boards
    35 *
    46 * This file describes the Clock Driver for all boards.
  • cpukit/libcsupport/include/timerdrv.h

    rf11858ac r9ab091e  
    22 * @file rtems/timerdrv.h
    33 *
    4  *  This file describes the Timer Driver for all boards.
     4 * @brief Timer Driver for all Boards
     5 *
     6 * This file describes the Timer Driver for all boards.
    57 */
    68
  • cpukit/libcsupport/include/zilog/z8036.h

    rf11858ac r9ab091e  
    11/**
    22 * @file rtems/zilog/z8036.h
     3 *
     4 * @brief Zilog Z8036 Counter/Timer/IO Chip
    35 *
    46 * This include file defines information related to a Zilog Z8036
  • cpukit/libfs/src/pipe/pipe.h

    rf11858ac r9ab091e  
    11/**
    22 * @file rtems/pipe.h
     3 *
     4 * @brief Defines the Interface to the POSIX FIFO/pipe File System Support
    35 *
    46 * This include file defines the interface to the POSIX FIFO/pipe file system
     
    2527/**
    2628 * @defgroup FIFO_PIPE FIFO/pipe File System Support
    27  * 
     29 *
    2830 * @brief Interface to the POSIX FIFO/pipe File System
    2931 */
     
    5153/**
    5254 * @brief Create an Anonymous Pipe
    53  * 
     55 *
    5456 * Called by pipe() to create an anonymous pipe.
    5557 */
     
    6062/**
    6163 * @brief Release a Pipe
    62  * 
     64 *
    6365 * Interface to file system close.
    6466 *
     
    8688/**
    8789 * @brief Pipe Read
    88  * 
     90 *
    8991 * Interface to file system read.
    9092 */
     
    98100/**
    99101 * @brief Pipe Write
    100  * 
     102 *
    101103 * Interface to file system write.
    102104 */
     
    110112/**
    111113 * @brief Pipe IO Control
    112  * 
     114 *
    113115 * Interface to file system ioctl.
    114116 */
  • cpukit/libfs/src/rfs/rtems-rfs-format.h

    rf11858ac r9ab091e  
     1/**
     2 * @file
     3 *
     4 * @ingroup rtems-rfs
     5 *
     6 * @brief RTEMS File System Format
     7 *
     8 * This function lets you format a disk in the RFS format.
     9 */
     10
    111/*
    212 *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
     
    515 *  found in the file LICENSE in this distribution or at
    616 *  http://www.rtems.com/license/LICENSE.
    7  */
    8 /**
    9  * @file
    10  *
    11  * @ingroup rtems-rfs
    12  *
    13  * RTEMS File System Format.
    14  *
    15  * This function lets you format a disk in the RFS format.
    1617 */
    1718
  • cpukit/libmisc/bspcmdline/bspcmdline.h

    rf11858ac r9ab091e  
    11/**
    22 *  @file  rtems/bspcmdline.h
     3 *
     4 *  @brief Related Prototypes and Specifications to
     5 *  BSP Command Line String and helper routines.
    36 *
    47 *  This include file contains all prototypes and specifications
  • cpukit/libmisc/fb/mw_uid.h

    rf11858ac r9ab091e  
    22 * @file rtems/mw_uid.h
    33 *
    4  * This file defines the interface for input devices used by MicroWindows
    5  * in an embedded system environment.
     4 * @brief Input device Interface for MicroWindows in an
     5 * Embedded System Enviroment
     6 *
     7 * This file defines the interface for input devices used by
     8 * MicroWindows in an embedded system environment.
    69 */
    710
  • cpukit/libmisc/serdbg/serdbgcnf.h

    rf11858ac r9ab091e  
     1/**
     2 * @file
     3 *
     4 * @brief Adds a GDB remote Debug Stub to an RTEMS System
     5 */
     6
    17/*===============================================================*\
    28| Project: RTEMS configure remote gdb over serial line            |
  • cpukit/libmisc/serdbg/termios_printk_cnf.h

    rf11858ac r9ab091e  
     1/**
     2 * @file
     3 *
     4 * @brief Adds printk Support via Polled termios
     5 */
     6
    17/*===============================================================*\
    28| Project: RTEMS configure remote gdb over serial line            |
  • cpukit/libmisc/stackchk/stackchk.h

    rf11858ac r9ab091e  
    1 /** @file rtems/stackchk.h
     1/**
     2 * @file rtems/stackchk.h
    23 *
    3  *  This include file contains information necessary to utilize
    4  *  and install the stack checker mechanism.
     4 * @brief Information Necessary to Utilize and Install the
     5 * Stack Checker Mechanism
     6 *
     7 * This include file contains information necessary to utilize
     8 * and install the stack checker mechanism.
    59 */
    610
  • cpukit/libqos/qreslib.h

    rf11858ac r9ab091e  
    22 * @file qreslib.h
    33 *
    4  *  This include file contains all the constants and structures associated
    5  *  with the QoS RES library in RTEMS.
     4 * @brief Constants and Structures Associated
     5 * with the QoS RES library in RTEMS
     6 *
     7 * This include file contains all the constants and structures
     8 * associated with the QoS RES library in RTEMS.
    69 *
    710 * @note The library is available only together with CBS scheduler.
  • cpukit/sapi/include/confdefs.h

    rf11858ac r9ab091e  
    11/**
    22 * @file rtems/confdefs.h
     3 *
     4 * @brief Configuration Table Template that will be Instantiated
     5 * by an Application
    36 *
    47 *  This include file contains the configuration table template that will
     
    176179   */
    177180  #if !defined(CONFIGURE_SMP_APPLICATION)
    178     #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS) 
     181    #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS)
    179182      #define CONFIGURE_SMP_MAXIMUM_PROCESSORS 1
    180183    #endif
    181184  #else
    182     #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS) 
     185    #if !defined(CONFIGURE_SMP_MAXIMUM_PROCESSORS)
    183186      #error "CONFIGURE_SMP_MAXIMUM_PROCESSORS not specified for SMP Application"
    184187    #endif
     
    260263        #error "Filesystems could be disabled, DEVFS is root, or"
    261264        #error "  miniIMFS is root!"
    262      #endif 
     265     #endif
    263266  #endif
    264267
     
    298301/**
    299302 *  This defines the miniIMFS file system table entry.
    300  */ 
     303 */
    301304#if !defined(CONFIGURE_FILESYSTEM_ENTRY_miniIMFS) && \
    302305    defined(CONFIGURE_FILESYSTEM_MINIIMFS)
     
    316319/**
    317320 *  This defines the IMFS file system table entry.
    318  */ 
     321 */
    319322#if !defined(CONFIGURE_FILESYSTEM_ENTRY_IMFS) && \
    320323    defined(CONFIGURE_FILESYSTEM_IMFS)
     
    353356/**
    354357 * DEVFS
    355  */ 
     358 */
    356359#if !defined(CONFIGURE_FILESYSTEM_ENTRY_DEVFS) && \
    357360    defined(CONFIGURE_FILESYSTEM_DEVFS)
     
    364367  /**
    365368   * FTPFS
    366    */ 
     369   */
    367370  #if !defined(CONFIGURE_FILESYSTEM_ENTRY_FTPFS) && \
    368       defined(CONFIGURE_FILESYSTEM_FTPFS) 
     371      defined(CONFIGURE_FILESYSTEM_FTPFS)
    369372    #include <rtems/ftpfs.h>
    370373    #define CONFIGURE_FILESYSTEM_ENTRY_FTPFS \
     
    374377  /**
    375378   * TFTPFS
    376    */ 
     379   */
    377380  #if !defined(CONFIGURE_FILESYSTEM_ENTRY_TFTPFS) && \
    378381      defined(CONFIGURE_FILESYSTEM_TFTPFS)
     
    384387  /**
    385388   * NFS
    386    */ 
     389   */
    387390  #if !defined(CONFIGURE_FILESYSTEM_ENTRY_NFS) && \
    388391      defined(CONFIGURE_FILESYSTEM_NFS)
     
    395398/**
    396399 * DOSFS
    397  */ 
     400 */
    398401#if !defined(CONFIGURE_FILESYSTEM_ENTRY_DOSFS) && \
    399402    defined(CONFIGURE_FILESYSTEM_DOSFS)
     
    405408/**
    406409 * RFS
    407  */ 
     410 */
    408411#if !defined(CONFIGURE_FILESYSTEM_ENTRY_RFS) && \
    409412    defined(CONFIGURE_FILESYSTEM_RFS)
     
    575578 * Scheduler configuration.
    576579 *
    577  * The scheduler configuration allows an application to select the 
     580 * The scheduler configuration allows an application to select the
    578581 * scheduling policy to use.  The supported configurations are:
    579582 *  CONFIGURE_SCHEDULER_USER       - user provided scheduler
     
    583586 *  CONFIGURE_SCHEDULER_EDF        - EDF Scheduler
    584587 *  CONFIGURE_SCHEDULER_CBS        - CBS Scheduler
    585  * 
    586  * If no configuration is specified by the application, then 
     588 *
     589 * If no configuration is specified by the application, then
    587590 * CONFIGURE_SCHEDULER_PRIORITY is assumed to be the default.
    588591 *
    589592 * An application can define its own scheduling policy by defining
    590593 * CONFIGURE_SCHEDULER_USER and the following:
    591  *    - CONFIGURE_SCHEDULER_ENTRY_POINTS 
     594 *    - CONFIGURE_SCHEDULER_ENTRY_POINTS
    592595 *    - CONFIGURE_MEMORY_FOR_SCHEDULER - base memory
    593596 *    - CONFIGURE_MEMORY_PER_TASK_FOR_SCHEDULER - per task memory
     
    613616#endif
    614617
    615 /* 
     618/*
    616619 * If the Priority Scheduler is selected, then configure for it.
    617620 */
     
    631634#endif
    632635
    633 /* 
     636/*
    634637 * If the Simple Priority Scheduler is selected, then configure for it.
    635638 */
     
    706709#endif
    707710
    708 /* 
     711/*
    709712 * Set up the scheduler entry points table.  The scheduling code uses
    710713 * this code to know which scheduler is configured by the user.
     
    859862    #endif
    860863  #endif
    861  
     864
    862865  #ifdef CONFIGURE_UNIFIED_WORK_AREAS
    863866    Heap_Control  *RTEMS_Malloc_Heap = &_Workspace_Area;
  • cpukit/sapi/include/rtems/cbs.h

    rf11858ac r9ab091e  
    22 * @file rtems/cbs.h
    33 *
    4  *  This include file contains all the constants and structures associated
    5  *  with the CBS library in RTEMS.
     4 * @brief Constants and Structures Associated
     5 * with the CBS library in RTEMS
     6 *
     7 * This include file contains all the constants and structures associated
     8 * with the CBS library in RTEMS.
    69 */
    710
  • cpukit/sapi/include/rtems/config.h

    rf11858ac r9ab091e  
    11/**
    22 * @file rtems/config.h
     3 *
     4 * @brief Table of User Defined Configuration Parameters
    35 *
    46 * This include file contains the table of user defined configuration
Note: See TracChangeset for help on using the changeset viewer.