RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

Header File Doxygen Enhancement Task #1

Browse Source
This commit is contained in:
Alex Ivanov
2012-12-28 17:48:12 -06:00
committed by Jennifer Averett
parent 7ee5bc4ce1
commit 3cf4031c19
20 changed files with 70 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cpukit/include/rtems/status-checks.h
View File

@@ -1,7 +1,7 @@
/**
* @file
*
* @brief Header file for status checks.
* @brief Header File for Status Checks
*
* @warning Do not include this file in other header files. Use it only in
* source files.

1
cpukit/include/rtems/userenv.h
View File

@@ -2,6 +2,7 @@
* @file
*
* @ingroup LibIOEnv
* @brief User Environment Support
*/
/*

3
cpukit/libblock/include/rtems/bdbuf.h
View File

@@ -2,8 +2,7 @@
* @file
*
* @ingroup rtems_bdbuf
*
* Block device buffer management.
* @brief Block Device Buffer Management
*/
/*

6
cpukit/libblock/include/rtems/ide_part_table.h
View File

@@ -1,7 +1,7 @@
/**
* @file rtems/ide_part_table.h
*
* Support for "MS-DOS-style" partition tables
* @file
*
* @brief "MS-DOS-style" Partition Tables Support
*/
/*

4
cpukit/libblock/include/rtems/ramdisk.h
View File

@@ -1,9 +1,7 @@
/**
* @file
*
* @ingroup rtems_ramdisk
*
* @brief RAM disk block device API.
* @brief RAM Disk Block Device API
*/
/*

6
cpukit/libcsupport/include/rtems/libcsupport.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/libcsupport.h
*
* @file
*
* @brief Standard C Library Support
*
* This include file contains the information regarding the
* RTEMS specific support for the standard C library.
*/

4
cpukit/libcsupport/include/rtems/libio_.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/libio_.h
* @file
*
* @brief LibIO Internal Interface
*
* This file is the libio internal interface.
*/

4
cpukit/libcsupport/include/vmeintr.h
View File

@@ -1,5 +1,7 @@
/**
* @file rtems/vmeintr.h
* @file
*
* @brief VMEbus Interface Library
*
* This file is the specification for the VMEbus interface library
* which should be provided by all BSPs for VMEbus Single Board

10
cpukit/libfs/src/devfs/devfs.h
View File

@@ -1,8 +1,10 @@
/**
* @file libfs/devfs/devfs.h
*
* This include file contains all constants and structures associated
* with the 'device-only' filesystem.
* @file
*
* @brief 'device-only' File System Support
*
* This include file contains all constants and structures associated
* with the 'device-only' filesystem.
*/
#ifndef _RTEMS_DEVFS_H

19
cpukit/libfs/src/rfs/rtems-rfs-shell.h
View File

@@ -1,3 +1,14 @@
/**
* @file
*
*
* @ingroup rtems-rfs
* @brief RTEMS File Systems Shell Commands
*
* RTEMS File Systems Shell commands provide a CLI interface to support and
* development of the RFS file system.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
@@ -5,14 +16,6 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Shell commands provide a CLI interface to support and
* development od the RFS file system.
*/
#if !defined (_RTEMS_RFS_SHELL_H_)
#define _RTEMS_RFS_SHELL_H_

4
cpukit/libmisc/devnull/devnull.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/devnull.h
* @file
*
* @brief RTEMS /dev/null Device Driver
*
* This include file defines the interface to the RTEMS /dev/null
* device driver.
*/

4
cpukit/libmisc/dumpbuf/dumpbuf.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/dumpbuf.h
* @file
*
* @brief Print a Memory Buffer
*
* This file defines the interface to the RTEMS methods to print a
* memory buffer in a style similar to many ROM monitors and debuggers.
*/

16
cpukit/libmisc/mouse/serial_mouse.h
View File

@@ -1,13 +1,15 @@
/**
* @file rtems/serial_mouse.h
* @file
*
* @brief Serial Mouse Driver
*
* This file describes the Serial Mouse Driver for all boards.
* This driver assumes that the BSP or application will provide
* an implementation of the method bsp_get_serial_mouse_device()
* which tells the driver what serial port device to open() and
* what type of mouse is connected.
* This file describes the Serial Mouse Driver for all boards.
* This driver assumes that the BSP or application will provide
* an implementation of the method bsp_get_serial_mouse_device()
* which tells the driver what serial port device to open() and
* what type of mouse is connected.
*
* This driver relies on the Mouse Parser Engine.
* This driver relies on the Mouse Parser Engine.
*/
/*

4
cpukit/libmisc/untar/untar.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/untar.h
* @file
*
* @brief Untar an Image
*
* This file defines the interface to methods which can untar an image.
*/

4
cpukit/libnetworking/memory.h
View File

@@ -1,7 +1,7 @@
/**
* @file memory.h
* @file
*
* Dummy include file for FreeBSD routines
* @brief Dummy Include File for FreeBSD Routines
*/
#include <string.h>

4
cpukit/posix/include/aio.h
View File

@@ -1,6 +1,8 @@
/**
* @file aio.h
* @file
*
* @brief POSIX Asynchronous Input and Output
*
* This file contains the definitions related to POSIX Asynchronous
* Input and Output,
*/

4
cpukit/posix/include/mqueue.h
View File

@@ -1,6 +1,8 @@
/**
* @file mqueue.h
* @file
*
* @brief POSIX Message Queues
*
* This file contains the definitions related to POSIX Message Queues.
*
* The structure of the routines is identical to that of POSIX

4
cpukit/sapi/include/rtems/io.h
View File

@@ -1,9 +1,7 @@
/**
* @file
*
* @ingroup ClassicIO
*
* @brief Classic Input/Output Manager API.
* @brief Classic Input/Output Manager API
*
* This file emulates the old Classic RTEMS IO manager directives
* which register and lookup names using the in-memory filesystem.

8
cpukit/sapi/include/rtems/timespec.h
View File

@@ -1,11 +1,9 @@
/**
* @file rtems/sapi/timespec.h
* @file
*
* @ingroup
* @brief Timespec API
*
* @brief Timespec API
*
* This include file contains API for manipulating timespecs.
* This include file contains API for manipulating timespecs.
*/
/*

10
cpukit/score/include/rtems/system.h
View File

@@ -1,9 +1,11 @@
/**
* @file rtems/system.h
* @file
*
* @brief Information Included in Every Function in the Executive
*
* This include file contains information that is included in every
* function in the executive. This must be the first include file
* included in all internal RTEMS files.
* This include file contains information that is included in every
* function in the executive. This must be the first include file
* included in all internal RTEMS files.
*/
/*