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

misc: Header File Doxygen Enhancement Task #3

Browse Source 
http://www.google-melange.com/gci/task/view/google/gci2012/8006220
This commit is contained in:
Mathew Kallada
2012-12-12 15:57:49 -05:00
committed by Gedare Bloom
parent f1eb368d1a
commit c2ae79e93c
20 changed files with 171 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cpukit/libcsupport/include/rtems/deviceio.h
View File

@@ -1,5 +1,7 @@
/**
* @file rtems/deviceio.h
*
* @brief Map Operations on IMFS Device Nodes to the RTEMS Classic API IO Manager
*/
/*

2
cpukit/libcsupport/include/zilog/z8530.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/zilog/z8530.h
*
* @brief Information Related to a Zilog Z8530 SCC Chip
*
* This include file defines information related to a Zilog Z8530
* SCC Chip. It is a IO mapped part.
*/

2
cpukit/libcsupport/include/zilog/z8536.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/zilog/z8536.h
*
* @brief Information Related to a Zilog Z8536 Counter/Timer/IO Chip
*
* This include file defines information related to a Zilog Z8536
* Counter/Timer/IO Chip. It is a IO mapped part.
*

18
cpukit/libfs/src/rfs/rtems-rfs-bitmaps.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File Systems Bitmap Routines
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Bitmap Routines.
@@ -18,6 +13,15 @@
* search bits can checked in a test.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_BITMAPS_H_)
#define _RTEMS_RFS_BITMAPS_H_

17
cpukit/libfs/src/rfs/rtems-rfs-block-pos.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File Systems Block Position and Size Management
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Block Position and Size Management.
@@ -23,6 +18,14 @@
* which set of rules are in use and the reason for this file.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_BLOCK_POS_H_)
#define _RTEMS_RFS_BLOCK_POS_H_

18
cpukit/libfs/src/rfs/rtems-rfs-block.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File Systems Block Management
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Block Management.
@@ -15,6 +10,15 @@
* These functions manage the blocks used in the file system.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_BLOCK_H_)
#define _RTEMS_RFS_BLOCK_H_

20
cpukit/libfs/src/rfs/rtems-rfs-buffer.h
View File

@@ -1,3 +1,13 @@
/**
* @file
*
* @ingroup rtems-rfs
*
* @brief Maps Blocks to the Media Interface Layers
*
* These functions map blocks to the media interface layers.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
@@ -5,15 +15,7 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Buffer Management.
*
* These functions map blocks to the media interface layers.
*/
#if !defined (_RTEMS_RFS_BUFFER_H_)
#define _RTEMS_RFS_BUFFER_H_

18
cpukit/libfs/src/rfs/rtems-rfs-data.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File System Data
*
* @ingroup rtems-rfs
*
* RTEMS File System Data.
@@ -18,6 +13,15 @@
* @todo Make direct access on matching byte ordered targets.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_DATA_H_)
#define _RTEMS_RFS_DATA_H_

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

@@ -1,3 +1,14 @@
/**
* @file
*
* @brief Provides a 32bit Hash of a String used to Search a Directory
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Directory Hash provides a 32bit hash of a string. This is
* used to search a directory.
*/
/*
* 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 Directory Hash provides a 32bit hash of a string. This is
* used to search a directory.
*/
#if !defined (_RTEMS_RFS_DIR_HASH_H_)
#define _RTEMS_RFS_DIR_HAS_H_

17
cpukit/libfs/src/rfs/rtems-rfs-dir.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File System Directory Support
*
* @ingroup rtems-rfs
*
* RTEMS File System Directory Support
@@ -15,6 +10,14 @@
* This file provides the directory support functions.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_DIR_H_)
#define _RTEMS_RFS_DIR_H_

18
cpukit/libfs/src/rfs/rtems-rfs-file-system-fwd.h
View File

@@ -1,3 +1,13 @@
/**
* @file
*
* @brief RTEMS File Systems Data forward decl
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Data forward decl.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
@@ -5,13 +15,7 @@
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Data forward decl.
*/
#if !defined (_RTEMS_RFS_FILE_SYSTEM_FWD_H_)
#define _RTEMS_RFS_FILE_SYSTEM_FWD_H_

17
cpukit/libfs/src/rfs/rtems-rfs-file-system.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File System Data
*
* @ingroup rtems-rfs
*
* RTEMS File System Data
@@ -15,6 +10,14 @@
* This file defines the file system data.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_FILE_SYSTEM_H_)
#define _RTEMS_RFS_FILE_SYSTEM_H_

17
cpukit/libfs/src/rfs/rtems-rfs-file.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File System File Support
*
* @ingroup rtems-rfs
*
* RTEMS File System File Support
@@ -15,6 +10,14 @@
* This file provides the support functions.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_FILE_H_)
#define _RTEMS_RFS_FILE_H_

18
cpukit/libfs/src/rfs/rtems-rfs-group.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File Systems Group Management
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Group Management.
@@ -15,6 +10,15 @@
* These functions manage the groups used in the file system.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_GROUP_H_)
#define _RTEMS_RFS_GROUP_H_

18
cpukit/libfs/src/rfs/rtems-rfs-inode.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File System Information Node
*
* @ingroup rtems-rfs
*
* RTEMS File System Information Node.
@@ -15,6 +10,15 @@
* The information nodes hold the data about all nodes in the file system.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_INODE_H_)
#define _RTEMS_RFS_INODE_H_

18
cpukit/libfs/src/rfs/rtems-rfs-link.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File System Link Support
*
* @ingroup rtems-rfs
*
* RTEMS File System Link Support
@@ -15,6 +10,15 @@
* This file provides the link support functions.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_LINK_H_)
#define _RTEMS_RFS_LINK_H_

17
cpukit/libfs/src/rfs/rtems-rfs-mutex.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief RTEMS File System Mutex
*
* @ingroup rtems-rfs
*
* RTEMS File System Mutex.
@@ -16,6 +11,14 @@
* is designed to be run on host operating systems.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_MUTEX_H_)
#define _RTEMS_RFS_MUTEX_H_

18
cpukit/libfs/src/rfs/rtems-rfs-trace.h
View File

@@ -1,13 +1,8 @@
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
/**
* @file
*
* @brief Manages the Trace and Debugging Features of the RTEMS RFS File System
*
* @ingroup rtems-rfs
*
* RTEMS File Systems Trace manages the trace and debugging features of the
@@ -15,6 +10,15 @@
* removed from the target code for small footprint systems.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#if !defined (_RTEMS_RFS_TRACE_H_)
#define _RTEMS_RFS_TRACE_H_

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

@@ -1,9 +1,9 @@
/**
* @file
*
* @ingroup RBHeap
* @brief Red-Black Tree Heap API
*
* @brief Red-Black Tree Heap API.
* @ingroup RBHeap
*/
/*

4
cpukit/score/include/rtems/debug.h
View File

@@ -1,6 +1,8 @@
/**
* @file rtems/debug.h
*
* @brief Information Related to the Debug Support Within RTEMS
*
* This include file contains the information pertaining to the debug
* support within RTEMS. It is currently cast in the form of a
* Manager since it is externally accessible.
@@ -65,7 +67,7 @@ void rtems_debug_disable(
/**
* @brief Check if Debug is Enabled
*
*
* This routine returns TRUE if the requested debug level is
* enabled, and FALSE otherwise.
*/