Header File Doxygen Enhancement Task #9
Cynthia Rempel
cynt6007 at vandals.uidaho.edu
Wed Dec 26 04:36:27 UTC 2012
Student: Ayush Awasthi
Email: kolaveridi87 at gmail.com
Please commit this patch
Thanks!
diff --git a/cpukit/posix/include/rtems/posix/aio_misc.h b/cpukit/posix/include/rtems/posix/aio_misc.h
index da92608..3bc7189 100644
--- a/cpukit/posix/include/rtems/posix/aio_misc.h
+++ b/cpukit/posix/include/rtems/posix/aio_misc.h
@@ -1,11 +1,12 @@
/**
* @file rtems/posix/aio_misc.h
*
- * This defines private information for the AIO implementation.
+ * @ingroup POSIX
+ * @brief This Defines Private Information For The AIO Implementation
*/
/*
- * Copyright 2010, Alin Rus <alin.codejunkie at gmail.com>
+ * Copyright 2010, Alin Rus <alin.codejunkie at gmail.com>
*
* 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.
*/
diff --git a/cpukit/posix/include/rtems/posix/barrier.h b/cpukit/posix/include/rtems/posix/barrier.h
index ce75358..d2d944d 100644
--- a/cpukit/posix/include/rtems/posix/barrier.h
+++ b/cpukit/posix/include/rtems/posix/barrier.h
@@ -1,23 +1,26 @@
/**
* @file rtems/posix/barrier.h
*
- * This include file contains all the constants and structures associated
- * with the POSIX Barrier Manager.
+ * @ingroup POSIX
+ * @brief POSIX Barrier Manager Initialization
*
- * Directives provided are:
+ * This include file contains all the constants and structures associated
+ * with the POSIX Barrier Manager.
*
- * - create a barrier
- * - delete a barrier
- * - wait for a barrier
+ * Directives provided are:
+ *
+ * - create a barrier
+ * - delete a barrier
+ * - wait for a barrier
*/
/*
* COPYRIGHT (c) 1989-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_POSIX_BARRIER_H
diff --git a/cpukit/posix/include/rtems/posix/cancel.h b/cpukit/posix/include/rtems/posix/cancel.h
index 06b8efd..ebfb699 100644
--- a/cpukit/posix/include/rtems/posix/cancel.h
+++ b/cpukit/posix/include/rtems/posix/cancel.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/cancel.h
*
+ * @ingroup POSIX
+ * @brief Canceling Execution of a Thread
+ *
* This file contains the prototypes and data types used to implement
* POSIX thread cancelation.
*/
@@ -9,9 +12,9 @@
* 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_POSIX_CANCEL_H
diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h
index 93b5b4c..0e918f4 100644
--- a/cpukit/posix/include/rtems/posix/cond.h
+++ b/cpukit/posix/include/rtems/posix/cond.h
@@ -1,7 +1,8 @@
/**
* @file rtems/posix/cond.h
*
- * This include file contains all the private support information for
- * POSIX condition variables
+ * @ingroup POSIX
+ * @brief This Include File Contains All The Private Support Information For
+ * POSIX Condition Variables
*/
@@ -9,9 +10,9 @@
* COPYRIGHT (c) 1989-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_POSIX_COND_H
diff --git a/cpukit/posix/include/rtems/posix/config.h b/cpukit/posix/include/rtems/posix/config.h
index ddd63ac..67a5e27 100644
--- a/cpukit/posix/include/rtems/posix/config.h
+++ b/cpukit/posix/include/rtems/posix/config.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/config.h
*
+ * @ingroup POSIX
+ * @brief POSIX API Configuration Table
+ *
* This include file contains the table of user defined configuration
* parameters specific for the POSIX API.
*/
@@ -9,9 +12,9 @@
* 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_POSIX_CONFIG_H
diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h
index edcaa42..a12c3af 100644
--- a/cpukit/posix/include/rtems/posix/key.h
+++ b/cpukit/posix/include/rtems/posix/key.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/key.h
*
+ * @ingroup POSIX
+ * @brief POSIX Keys Manager Initialization
+ *
* This include file contains all the private support information for
* POSIX key.
*/
@@ -9,9 +12,9 @@
* COPYRIGHT (c) 1989-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_POSIX_KEY_H
diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h
index 582d5b7..ac415d0 100644
--- a/cpukit/posix/include/rtems/posix/mqueue.h
+++ b/cpukit/posix/include/rtems/posix/mqueue.h
@@ -1,29 +1,30 @@
/**
* @file rtems/posix/mqueue.h
*
+ * @ingroup POSIX
+ * @brief Initializes message_queue Manager Related Data Structures
+ *
* This include file contains all the private support information for
* POSIX Message Queues.
- *
- * The structure of the routines is identical to that of POSIX
- * Message_queues to leave the option of having unnamed message
- * queues at a future date. They are currently not part of the
- * POSIX standard but unnamed message_queues are. This is also
- * the reason for the apparently unnecessary tracking of
- * the process_shared attribute. [In addition to the fact that
- * it would be trivial to add pshared to the mq_attr structure
- * and have process private message queues.]
- *
- * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open
- * time.
+ * The structure of the routines is identical to that of POSIX
+ * Message_queues to leave the option of having unnamed message
+ * queues at a future date. They are currently not part of the
+ * POSIX standard but unnamed message_queues are. This is also
+ * the reason for the apparently unnecessary tracking of
+ * the process_shared attribute. [In addition to the fact that
+ * it would be trivial to add pshared to the mq_attr structure
+ * and have process private message queues.]
+ * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open
+ * time.
*/
/*
* COPYRIGHT (c) 1989-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_POSIX_MQUEUE_H
diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h
index 727745a..c851e4f 100644
--- a/cpukit/posix/include/rtems/posix/mutex.h
+++ b/cpukit/posix/include/rtems/posix/mutex.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/mutex.h
*
+ * @ingroup POSIX
+ * @brief Private Support Information for POSIX Mutex
+ *
* This include file contains all the private support information for
* POSIX mutex's.
*/
@@ -9,9 +12,9 @@
* COPYRIGHT (c) 1989-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_POSIX_MUTEX_H
diff --git a/cpukit/posix/include/rtems/posix/posixapi.h b/cpukit/posix/include/rtems/posix/posixapi.h
index cb61ba0..536db3f 100644
--- a/cpukit/posix/include/rtems/posix/posixapi.h
+++ b/cpukit/posix/include/rtems/posix/posixapi.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/posixapi.h
*
+ * @ingroup POSIX
+ * @brief Initialization of POSIX API
+ *
* This include file defines the top level interface to the POSIX API
* implementation in RTEMS.
*/
@@ -9,9 +12,9 @@
* COPYRIGHT (c) 1989-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_POSIX_POSIXAPI_H
diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h
index a6a3c28..b86ba25 100644
--- a/cpukit/posix/include/rtems/posix/priority.h
+++ b/cpukit/posix/include/rtems/posix/priority.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/priority.h
*
+ * @ingroup POSIX
+ * @brief Interface to the POSIX Priority Implementation
+ *
* This include file defines the interface to the POSIX priority
* implementation.
*/
@@ -9,9 +12,9 @@
* COPYRIGHT (c) 1989-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_POSIX_PRIORITY_H
diff --git a/cpukit/posix/include/rtems/posix/psignal.h b/cpukit/posix/include/rtems/posix/psignal.h
index 604b989..0997734 100644
--- a/cpukit/posix/include/rtems/posix/psignal.h
+++ b/cpukit/posix/include/rtems/posix/psignal.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/psignal.h
*
+ * @ingroup POSIX
+ * @brief POSIX Signals Manager Initialization
+ *
* This include file defines internal information about POSIX signals.
*/
@@ -8,9 +11,9 @@
* COPYRIGHT (c) 1989-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_POSIX_PSIGNAL_H
diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h
index 5932d45..ae3df47 100644
--- a/cpukit/posix/include/rtems/posix/pthread.h
+++ b/cpukit/posix/include/rtems/posix/pthread.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/pthread.h
*
+ * @ingroup POSIX
+ * @brief Private Support Information for POSIX Threads
+ *
* This include file contains all the private support information for
* POSIX threads.
*/
@@ -9,9 +12,9 @@
* COPYRIGHT (c) 1989-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_POSIX_PTHREAD_H
diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h
index 1b791cc..9d92d29 100644
--- a/cpukit/posix/include/rtems/posix/ptimer.h
+++ b/cpukit/posix/include/rtems/posix/ptimer.h
@@ -1,20 +1,23 @@
/**
* @file rtems/posix/ptimer.h
*
+ * @ingroup POSIX
+ * @brief POSIX Per-Process Timer
+ *
* This include file contains all the private support information for
* POSIX timers.
*/
/*
* Initial Implementation:
- * COPYRIGHT (c) 1998. Alfonso Escalera Piña
+ * COPYRIGHT (c) 1998. Alfonso Escalera Piña
* Largely rewritten by Joel Sherrill.
*
- * 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.
*
- * ptimer.h,v 1.0 1998/03/31 16:21:16
+ * ptimer.h,v 1.0 1998/03/31 16:21:16
*/
#ifndef _RTEMS_POSIX_PTIMER_H
diff --git a/cpukit/posix/include/rtems/posix/rwlock.h b/cpukit/posix/include/rtems/posix/rwlock.h
index 411384c..5c4a999 100644
--- a/cpukit/posix/include/rtems/posix/rwlock.h
+++ b/cpukit/posix/include/rtems/posix/rwlock.h
@@ -1,23 +1,26 @@
/**
* @file rtems/posix/rwlock.h
*
+ * @ingroup POSIX
+ * @brief Constants and Structures Associated with the POSIX RWLock Manager
+ *
* This include file contains all the constants and structures associated
* with the POSIX RWLock Manager.
*
* Directives provided are:
*
- * - create a RWLock
- * - delete a RWLock
- * - wait for a RWLock
+ * - create a RWLock
+ * - delete a RWLock
+ * - wait for a RWLock
*/
/*
* COPYRIGHT (c) 1989-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_POSIX_RWLOCK_H
diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h
index 08ace76..e3c2218 100644
--- a/cpukit/posix/include/rtems/posix/semaphore.h
+++ b/cpukit/posix/include/rtems/posix/semaphore.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/semaphore.h
*
+ * @ingroup POSIX
+ * @brief POSIX Semaphore Manager Initialization
+ *
* This include file contains all the private support information for
* POSIX Semaphores.
*/
@@ -9,9 +12,9 @@
* COPYRIGHT (c) 1989-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_POSIX_SEMAPHORE_H
diff --git a/cpukit/posix/include/rtems/posix/sigset.h b/cpukit/posix/include/rtems/posix/sigset.h
index b0dd61f..c44b71f 100644
--- a/cpukit/posix/include/rtems/posix/sigset.h
+++ b/cpukit/posix/include/rtems/posix/sigset.h
@@ -1,17 +1,18 @@
/**
* @file rtems/posix/sigset.h
*
- * This file defines the interface to implementation helper for management
- * of POSIX Signal Sets.
+ * @ingroup POSIX
+ * @brief This File Defines The Interface To Implementation Helper For
+ * Management Of POSIX Signal Sets
*/
/*
* COPYRIGHT (c) 1989-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_POSIX_SIGSET_H
diff --git a/cpukit/posix/include/rtems/posix/spinlock.h b/cpukit/posix/include/rtems/posix/spinlock.h
index 44061bd..d2c7605 100644
--- a/cpukit/posix/include/rtems/posix/spinlock.h
+++ b/cpukit/posix/include/rtems/posix/spinlock.h
@@ -1,23 +1,26 @@
/**
* @file rtems/posix/spinlock.h
*
+ * @ingroup POSIX
+ * @brief Constants and Structures Associated with the POSIX Spinlock Manager
+ *
* This include file contains all the constants and structures associated
* with the POSIX Spinlock Manager.
*
- * Directives provided are:
+ * Directives provided are:
*
- * - create a spinlock
- * - delete a spinlock
- * - wait for a spinlock
+ * - create a spinlock
+ * - delete a spinlock
+ * - wait for a spinlock
*/
/*
* COPYRIGHT (c) 1989-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_POSIX_SPINLOCK_H
diff --git a/cpukit/posix/include/rtems/posix/threadsup.h b/cpukit/posix/include/rtems/posix/threadsup.h
index c5a2e3d..422af59 100644
--- a/cpukit/posix/include/rtems/posix/threadsup.h
+++ b/cpukit/posix/include/rtems/posix/threadsup.h
@@ -1,16 +1,17 @@
/**
* @file rtems/posix/threadsup.h
*
- * This defines the POSIX thread API extension.
+ * @ingroup POSIX
+ * @brief This Defines The POSIX Thread API Extension
*/
/*
* COPYRIGHT (c) 1989-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_POSIX_THREADSUP_H
diff --git a/cpukit/posix/include/rtems/posix/time.h b/cpukit/posix/include/rtems/posix/time.h
index d0dc4a2..a58ddb6 100644
--- a/cpukit/posix/include/rtems/posix/time.h
+++ b/cpukit/posix/include/rtems/posix/time.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/time.h
*
+ * @ingroup POSIX
+ * @brief Absolute Timeout Conversion Results
+ *
* This defines the interface to implementation helper routines related
* to POSIX time types.
*/
diff --git a/cpukit/posix/include/rtems/posix/timer.h b/cpukit/posix/include/rtems/posix/timer.h
index 1298178..53d80ab 100644
--- a/cpukit/posix/include/rtems/posix/timer.h
+++ b/cpukit/posix/include/rtems/posix/timer.h
@@ -1,6 +1,9 @@
/**
* @file rtems/posix/timer.h
*
+ * @ingroup POSIX
+ * @brief POSIX Internal Timers
+ *
* This include files defines the internal support for implementation of
* POSIX Timers.
*/
@@ -9,9 +12,9 @@
* COPYRIGHT (c) 1989-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_POSIX_TIMER_H
More information about the devel
mailing list