[1/1] Header File Doxygen Enhancement Task #6
Cynthia Rempel
cynt6007 at vandals.uidaho.edu
Wed Dec 26 00:40:12 UTC 2012
Student: Ayush Awasthi
Email: kolaveridi87 at gmail.com
Please commit this patch
Thanks!
diff --git a/cpukit/include/rtems/endian.h b/cpukit/include/rtems/endian.h
index 74ef1c4..8f07a75 100644
--- a/cpukit/include/rtems/endian.h
+++ b/cpukit/include/rtems/endian.h
@@ -1,7 +1,7 @@
/**
* @file rtems/endian.h
*
- * This include file provides endian information about the target.
+ * @brief This include file provides endian information about the target.
*/
/*
diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h
index c428bcf..fbb8850 100644
--- a/cpukit/libcsupport/include/rtems/malloc.h
+++ b/cpukit/libcsupport/include/rtems/malloc.h
@@ -1,6 +1,8 @@
/**
* @file rtems/malloc.h
*
+ * @brief RTEMS Malloc Family Implementation
+ *
* This file defines the interface to RTEMS extensions to the Malloc Family.
*/
@@ -8,9 +10,9 @@
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
- * The license and distribution terms for this file may in
- * the file LICENSE in this distribution or at
- * http://www.rtems.com/license/LICENSE.
+ * The license and distribution terms for this file may in
+ * the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
*/
#ifndef _RTEMS_MALLOC_H
diff --git a/cpukit/libfs/src/rfs/rtems-rfs.h b/cpukit/libfs/src/rfs/rtems-rfs.h
index 251a618..4e0d8c3 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs.h
@@ -1,9 +1,18 @@
+/**
+ * @file rtems-rfs.h
+ *
+ * @ingroup rtems-rfs
+ * @brief RTEMS File System
+ *
+ * Initialise the RFS File System
+ */
+
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj at 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.
+ * 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
diff --git a/cpukit/libmisc/capture/capture-cli.h b/cpukit/libmisc/capture/capture-cli.h
index 8f97522..fb4255a 100644
--- a/cpukit/libmisc/capture/capture-cli.h
+++ b/cpukit/libmisc/capture/capture-cli.h
@@ -1,33 +1,34 @@
/**
* @file rtems/capture-cli.h
*
+ * @brief This function initialises the command line interface to the capture
+ * engine.
+ *
* This is the Target Interface Command Line Interface. You need
* start the RTEMS monitor.
*/
/*
+ ------------------------------------------------------------------------
+ * Copyright Objective Design Systems Pty Ltd, 2002
+ * All rights reserved Objective Design Systems Pty Ltd, 2002
+ * Chris Johns (ccj at acm.org)
+ *
+ * COPYRIGHT (c) 1989-1998.
+ * On-Line Applications Research Corporation (OAR).
+ *
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution.
+ *
+ * This software with is provided ``as is'' and with NO WARRANTY.
+ */
------------------------------------------------------------------------
-
- Copyright Objective Design Systems Pty Ltd, 2002
- All rights reserved Objective Design Systems Pty Ltd, 2002
- Chris Johns (ccj at acm.org)
-
- COPYRIGHT (c) 1989-1998.
- On-Line Applications Research Corporation (OAR).
-
- The license and distribution terms for this file may be
- found in the file LICENSE in this distribution.
-
- This software with is provided ``as is'' and with NO WARRANTY.
-
- ------------------------------------------------------------------------
-
- RTEMS Performance Monitoring and Measurement Framework.
-
- This is the Target Interface Command Line Interface. You need
- start the RTEMS monitor.
-
-*/
+/*
+ * RTEMS Performance Monitoring and Measurement Framework.
+ *
+ * This is the Target Interface Command Line Interface. You need
+ * start the RTEMS monitor.
+ */
#ifndef __CAPTURE_CLI_H_
#define __CAPTURE_CLI_H_
diff --git a/cpukit/libmisc/serdbg/termios_printk.h b/cpukit/libmisc/serdbg/termios_printk.h
index dcb1835..58d130c 100644
--- a/cpukit/libmisc/serdbg/termios_printk.h
+++ b/cpukit/libmisc/serdbg/termios_printk.h
@@ -1,3 +1,19 @@
+/**
+ * @file rtems/termios_printk.h
+ *
+ * @brief RTEMS remote gdb over serial line
+ *
+ * this file declares intialization functions to add
+ * printk polled output via termios polled drivers
+ */
+
+/*
+ * Copyright (c) 2002 IMD
+ *
+ * Ingenieurbuero fuer Microcomputertechnik Th. Doerfler
+ * <Thomas.Doerfler at imd-systems.de> all rights reserved
+ */
+
/*===============================================================*\
| Project: RTEMS remote gdb over serial line |
+-----------------------------------------------------------------+
diff --git a/cpukit/score/include/rtems/score/address.h b/cpukit/score/include/rtems/score/address.h
index a09d638..e4a8d9c 100644
--- a/cpukit/score/include/rtems/score/address.h
+++ b/cpukit/score/include/rtems/score/address.h
@@ -1,17 +1,21 @@
/**
- * @file rtems/score/address.h
+ * @file rtems/score/address.h
*
- * This include file contains the information required to manipulate
- * physical addresses.
+ * @ingroup ScoreAddress
+ * @brief This include file contains the information required to manipulate
+ * physical addresses.
+ *
+ * This handler encapsulates functionality which abstracts address
+ * manipulation in a portable manner.
*/
/*
* COPYRIGHT (c) 1989-2006.
- * On-Line Applications Research Corporation (OAR).
+ * On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_ADDRESS_H
@@ -22,7 +26,7 @@
*
* @ingroup Score
*
- * This handler encapsulates functionality which abstracts address
- * manipulation in a portable manner
+ * @brief This handler encapsulates functionality which abstracts address
+ * manipulation in a portable manner.
*/
/**@{*/
diff --git a/cpukit/score/include/rtems/score/apimutex.h b/cpukit/score/include/rtems/score/apimutex.h
index 13b0ddd..2b30886 100644
--- a/cpukit/score/include/rtems/score/apimutex.h
+++ b/cpukit/score/include/rtems/score/apimutex.h
@@ -2,17 +2,18 @@
* @file rtems/score/apimutex.h
*
* @ingroup ScoreAPIMutex
* @brief API Mutex Handler API.
+ *
+ * Provides routines to ensure mutual exclusion on API level.
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_APIMUTEX_H
diff --git a/cpukit/score/include/rtems/score/chain.h b/cpukit/score/include/rtems/score/chain.h
index ebb0f24..322e3cb 100644
--- a/cpukit/score/include/rtems/score/chain.h
+++ b/cpukit/score/include/rtems/score/chain.h
@@ -2,19 +2,24 @@
* @file rtems/score/chain.h
*
* @ingroup ScoreChain
* @brief Chain Handler API.
+ *
+ * The Chain Handler is used to manage sets of entities. This handler
+ * provides two data structures. The Chain Node data structure is included
+ * as the first part of every data structure that will be placed on
+ * a chain. The second data structure is Chain Control which is used
+ * to manage a set of Chain Nodes.
*/
/*
* Copyright (c) 2010 embedded brains GmbH.
*
- * COPYRIGHT (c) 1989-2006.
- * On-Line Applications Research Corporation (OAR).
+ * COPYRIGHT (c) 1989-2006.
+ * On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_CHAIN_H
diff --git a/cpukit/score/include/rtems/score/corespinlock.h b/cpukit/score/include/rtems/score/corespinlock.h
index dfa62cc..03cba17 100644
--- a/cpukit/score/include/rtems/score/corespinlock.h
+++ b/cpukit/score/include/rtems/score/corespinlock.h
@@ -1,17 +1,20 @@
/**
- * @file rtems/score/corespinlock.h
+ * @file rtems/score/corespinlock.h
*
- * This include file contains all the constants and structures associated
- * with the Spinlock Handler.
+ * @ingroup ScoreSpinlock
+ * @brief Initialize a Spinlock
+ *
+ * This include file contains all the constants and structures associated
+ * with the Spinlock Handler.
*/
/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_CORESPINLOCK_H
diff --git a/cpukit/score/include/rtems/score/isr.h b/cpukit/score/include/rtems/score/isr.h
index 0d93d29..0c7cc23 100644
--- a/cpukit/score/include/rtems/score/isr.h
+++ b/cpukit/score/include/rtems/score/isr.h
@@ -1,19 +1,22 @@
/**
- * @file rtems/score/isr.h
+ * @file rtems/score/isr.h
*
- * This include file contains all the constants and structures associated
- * with the management of processor interrupt levels. This handler
- * supports interrupt critical sections, vectoring of user interrupt
- * handlers, nesting of interrupts, and manipulating interrupt levels.
+ * @ingroup ScoreISR
+ * @brief Initialize the ISR handler
+ *
+ * This include file contains all the constants and structures associated
+ * with the management of processor interrupt levels. This handler
+ * supports interrupt critical sections, vectoring of user interrupt
+ * handlers, nesting of interrupts, and manipulating interrupt levels.
*/
/*
* COPYRIGHT (c) 1989-2012.
* On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_ISR_H
diff --git a/cpukit/score/include/rtems/score/scheduleredf.h b/cpukit/score/include/rtems/score/scheduleredf.h
index 8381184..efc7213 100644
--- a/cpukit/score/include/rtems/score/scheduleredf.h
+++ b/cpukit/score/include/rtems/score/scheduleredf.h
@@ -1,17 +1,20 @@
/**
- * @file rtems/score/scheduleredf.h
+ * @file rtems/score/scheduleredf.h
*
- * This include file contains all the constants and structures associated
- * with the manipulation of threads for the EDF scheduler.
+ * @ingroup ScoreScheduler
+ * @brief Scheduler EDF Initialize and Support
+ *
+ * This include file contains all the constants and structures associated
+ * with the manipulation of threads for the EDF scheduler.
*/
/*
* Copryight (c) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_SCHEDULEREDF_H
diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h
index 66b4018..627c2ca 100644
--- a/cpukit/score/include/rtems/score/schedulersimple.h
+++ b/cpukit/score/include/rtems/score/schedulersimple.h
@@ -1,15 +1,20 @@
/**
- * @file rtems/score/schedulersimple.h
- *
- * This include file contains all the constants and structures associated
- * with the manipulation of threads on a simple-priority-based ready queue.
- *
- *
+ * @file rtems/score/schedulersimple.h
+ *
+ * @ingroup ScoreScheduler
+ * @brief Scheduling Simple Functions
+ *
+ * This include file contains all the constants and structures
+ * associated with the manipulation of threads on a simple-priority-based ready
+ * queue.
+ */
+
+/*
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_SCHEDULERSIMPLE_H
diff --git a/cpukit/score/include/rtems/score/sysstate.h b/cpukit/score/include/rtems/score/sysstate.h
index b847dc8..bd611b7 100644
--- a/cpukit/score/include/rtems/score/sysstate.h
+++ b/cpukit/score/include/rtems/score/sysstate.h
@@ -1,9 +1,10 @@
/**
- * @file
+ * @file rtems/score/systate.h
*
* @ingroup ScoreSysState
- *
* @brief System State Handler API.
+ *
+ * Management of the internal system state of RTEMS
*/
/*
diff --git a/cpukit/score/include/rtems/score/threadsync.h b/cpukit/score/include/rtems/score/threadsync.h
index df8ce5f..3ecae05 100644
--- a/cpukit/score/include/rtems/score/threadsync.h
+++ b/cpukit/score/include/rtems/score/threadsync.h
@@ -1,18 +1,21 @@
/**
- * @file rtems/score/threadsync.h
+ * @file rtems/score/threadsync.h
*
- * This include file contains all constants and structures associated
- * with synchronizing a thread blocking operation with potential
- * actions in an ISR.
+ * @ingroup ScoreThreadSync
+ * @brief Thread Blocking Operation Synchronization Handler
+ *
+ * This include file contains all constants and structures associated
+ * with synchronizing a thread blocking operation with potential
+ * actions in an ISR.
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_THREAD_SYNC_H
diff --git a/cpukit/score/include/rtems/score/timestamp64.h b/cpukit/score/include/rtems/score/timestamp64.h
index 41735fa..4ed951d 100644
--- a/cpukit/score/include/rtems/score/timestamp64.h
+++ b/cpukit/score/include/rtems/score/timestamp64.h
@@ -1,17 +1,21 @@
/**
- * @file rtems/score/timestamp64.h
+ * @file rtems/score/timestamp64.h
*
- * This include file contains helpers for manipulating
- * 64-bit integer timestamps.
+ * @ingroup ScoreSuperCore
+ * @brief This include file contains helpers for manipulating
+ * 64-bit integer timestamps.
+ *
+ * This handler encapsulates functionality related to manipulating
+ * the 64 bit integer implementation of SuperCore Timestamps.
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_TIMESTAMP64_H
diff --git a/cpukit/score/include/rtems/score/wkspace.h b/cpukit/score/include/rtems/score/wkspace.h
index ffac4cb..845b492 100644
--- a/cpukit/score/include/rtems/score/wkspace.h
+++ b/cpukit/score/include/rtems/score/wkspace.h
@@ -1,18 +1,21 @@
/**
- * @file rtems/score/wkspace.h
+ * @file rtems/score/wkspace.h
*
- * This include file contains information related to the
- * RAM Workspace. This Handler provides mechanisms which can be used to
- * define, initialize and manipulate the workspace.
+ * @ingroup ScoreWorkspace
+ * @brief Workspace Handler Support
+ *
+ * This include file contains information related to the
+ * RAM Workspace. This Handler provides mechanisms which can be used to
+ * define, initialize and manipulate the workspace.
*/
/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
- * 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.
+ * 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.
*/
#ifndef _RTEMS_SCORE_WKSPACE_H
More information about the devel
mailing list