Add doxygen preamble.

2004-11-02 09:56:13 +00:00
parent 4b48736344
commit d964f79f46
33 changed files with 165 additions and 66 deletions
--- a/cpukit/rtems/include/rtems.h
+++ b/cpukit/rtems/include/rtems.h
@@ -1,5 +1,8 @@
-/*  rtems.h
- *
+/**
+ * @file  rtems.h
+ */
+ 
+/*
 *  This include file contains information about RTEMS executive that
 *  is required by the application and is CPU independent.  It includes
 *  two (2) CPU dependent files to tailor its data structures for a
--- a/cpukit/rtems/inline/rtems/rtems/asr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/asr.inl
@@ -1,5 +1,8 @@
-/*  inline/asr.inl
- *
+/**
+ * @file rtems/rtems/asr.inl
+ */
+
+/*
 *  This include file contains the implemenation of all routines
 *  associated with the asynchronous signal handler which are inlined.
 *
--- a/cpukit/rtems/inline/rtems/rtems/attr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/attr.inl
@@ -1,5 +1,8 @@
-/*  inline/attr.inl
- *
+/**
+ * @file rtems/rtems/attr.inl
+ */
+
+/*
 *  This include file contains all of the inlined routines associated
 *  with attributes.
 *
--- a/cpukit/rtems/inline/rtems/rtems/dpmem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
@@ -1,5 +1,8 @@
-/*  inline/dpmem.inl
- *
+/**
+ * @file rtems/rtems/dpmem.inl
+ */
+
+/*
 *  This include file contains the inline routine used in conjunction
 *  with the Dual Ported Memory Manager
 *
--- a/cpukit/rtems/inline/rtems/rtems/event.inl
+++ b/cpukit/rtems/inline/rtems/rtems/event.inl
@@ -1,5 +1,8 @@
-/*  inline/event.inl
- *
+/**
+ * @file rtems/rtems/event.inl
+ */
+
+/*
 *  This include file contains the static inline implementation of
 *  macros for the Event Manager.
 *
--- a/cpukit/rtems/inline/rtems/rtems/eventset.inl
+++ b/cpukit/rtems/inline/rtems/rtems/eventset.inl
@@ -1,5 +1,8 @@
-/*  inline/eventset.inl
- *
+/**
+ * @file rtems/rtems/eventset.inl
+ */
+
+/*
 *  This include file contains the information pertaining to event sets.
 *
 *  COPYRIGHT (c) 1989-1999.
--- a/cpukit/rtems/inline/rtems/rtems/message.inl
+++ b/cpukit/rtems/inline/rtems/rtems/message.inl
@@ -1,5 +1,8 @@
-/*  message.inl
- *
+/**
+ * @file rtems/rtems/message.inl
+ */
+
+/*
 *  This include file contains the static inline implementation of all
 *  inlined routines in the Message Manager.
 *
--- a/cpukit/rtems/inline/rtems/rtems/modes.inl
+++ b/cpukit/rtems/inline/rtems/rtems/modes.inl
@@ -1,5 +1,8 @@
-/*  modes.inl
- *
+/**
+ * @file rtems/rtems/modes.inl
+ */
+
+/*
 *  This include file contains the static inline implementation of the
 *  inlined routines in the Mode Handler
 *
--- a/cpukit/rtems/inline/rtems/rtems/options.inl
+++ b/cpukit/rtems/inline/rtems/rtems/options.inl
@@ -1,5 +1,8 @@
-/*  options.inl
- *
+/**
+ * @file rtems/rtems/options.inl
+ */
+
+/*
 *  This file contains the static inline implementation of the inlined
 *  routines from the Options Handler.
 *
--- a/cpukit/rtems/inline/rtems/rtems/part.inl
+++ b/cpukit/rtems/inline/rtems/rtems/part.inl
@@ -1,5 +1,8 @@
-/*  part.inl
- *
+/**
+ * @file rtems/rtems/part.inl
+ */
+
+/*
 *  This file contains the macro implementation of all inlined routines
 *  in the Partition Manager.
 *
--- a/cpukit/rtems/inline/rtems/rtems/ratemon.inl
+++ b/cpukit/rtems/inline/rtems/rtems/ratemon.inl
@@ -1,5 +1,8 @@
-/*  ratemon.inl
- *
+/**
+ * @file rtems/rtems/ratemon.inl
+ */
+
+/*
 *  This file contains the static inline  implementation of the inlined
 *  routines in the Rate Monotonic Manager.
 *
--- a/cpukit/rtems/inline/rtems/rtems/region.inl
+++ b/cpukit/rtems/inline/rtems/rtems/region.inl
@@ -1,5 +1,8 @@
-/*  region.inl
- *
+/**
+ * @file rtems/rtems/region.inl
+ */
+
+/*
 *  This file contains the macro implementation of the inlined
 *  routines from the Region Manager.
 *
--- a/cpukit/rtems/inline/rtems/rtems/sem.inl
+++ b/cpukit/rtems/inline/rtems/rtems/sem.inl
@@ -1,5 +1,8 @@
-/*  sem.inl
- *
+/**
+ * @file rtems/rtems/sem.inl
+ */
+
+/*
 *  This file contains the static inlin implementation of the inlined
 *  routines from the Semaphore Manager.
 *
--- a/cpukit/rtems/inline/rtems/rtems/status.inl
+++ b/cpukit/rtems/inline/rtems/rtems/status.inl
@@ -1,5 +1,8 @@
-/*  inline/status.inl
- *
+/**
+ * @file rtems/rtems/status.inl
+ */
+
+/*
 *  This include file contains the implementations of the inlined
 *  routines for the status package.
 *
--- a/cpukit/rtems/inline/rtems/rtems/support.inl
+++ b/cpukit/rtems/inline/rtems/rtems/support.inl
@@ -1,5 +1,8 @@
-/*  support.inl
- *
+/**
+ * @file rtems/rtems/support.inl
+ */
+
+/*
 *  This include file contains the static inline implementation of all
 *  of the inlined routines specific to the RTEMS API.
 *
--- a/cpukit/rtems/inline/rtems/rtems/tasks.inl
+++ b/cpukit/rtems/inline/rtems/rtems/tasks.inl
@@ -1,5 +1,8 @@
-/*  tasks.inl
- *
+/**
+ * @file rtems/rtems/tasks.inl
+ */
+
+/*
 *  This file contains the static inline implementation of all inlined
 *  routines in the with RTEMS Tasks Manager.
 *
--- a/cpukit/rtems/inline/rtems/rtems/timer.inl
+++ b/cpukit/rtems/inline/rtems/rtems/timer.inl
@@ -1,5 +1,8 @@
-/*  timer.inl
- *
+/**
+ * @file rtems/rtems/timer.inl
+ */
+
+/*
 *  This file contains the static inline implementation of the inlined routines
 *  from the Timer Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/asr.inl
+++ b/cpukit/rtems/macros/rtems/rtems/asr.inl
@@ -1,5 +1,8 @@
-/*  macros/asr.h
- *
+/**
+ * @file rtems/rtems/asr.inl
+ */
+
+/*
 *  This include file contains the implemenation of all routines
 *  associated with the asynchronous signal handler which are inlined.
 *
--- a/cpukit/rtems/macros/rtems/rtems/attr.inl
+++ b/cpukit/rtems/macros/rtems/rtems/attr.inl
@@ -1,5 +1,8 @@
-/*  macros/attr.h
- *
+/**
+ * @file rtems/rtems/attr.inl
+ */
+
+/*
 *  This include file contains all of the inlined routines associated
 *  with attributes.
 *
--- a/cpukit/rtems/macros/rtems/rtems/dpmem.inl
+++ b/cpukit/rtems/macros/rtems/rtems/dpmem.inl
@@ -1,5 +1,8 @@
-/*  macros/dpmem.h
- *
+/**
+ * @file rtems/rtems/dpmem.inl
+ */
+
+/*
 *  This include file contains the inline routine used in conjunction
 *  with the Dual Ported Memory Manager
 *
--- a/cpukit/rtems/macros/rtems/rtems/event.inl
+++ b/cpukit/rtems/macros/rtems/rtems/event.inl
@@ -1,5 +1,8 @@
-/*  macros/event.h
- *
+/**
+ * @file rtems/rtems/event.inl
+ */
+
+/*
 *  This include file contains the implementation of macros for
 *  the Event Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/eventset.inl
+++ b/cpukit/rtems/macros/rtems/rtems/eventset.inl
@@ -1,5 +1,8 @@
-/*  eventset.inl
- *
+/**
+ * @file rtems/rtems/eventset.inl
+ */
+
+/*
 *  This include file contains the macro implementation of inlined
 *  routines in the event set object.
 *
--- a/cpukit/rtems/macros/rtems/rtems/message.inl
+++ b/cpukit/rtems/macros/rtems/rtems/message.inl
@@ -1,5 +1,8 @@
-/*  message.inl
- *
+/**
+ * @file rtems/rtems/message.inl
+ */
+
+/*
 *  This include file contains the macro implementation of all
 *  inlined routines in the Message Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/modes.inl
+++ b/cpukit/rtems/macros/rtems/rtems/modes.inl
@@ -1,5 +1,8 @@
-/*  modes.inl
- *
+/**
+ * @file rtems/rtems/modes.inl
+ */
+
+/*
 *  This include file contains the macro implementation of the
 *  inlined routines in the Mode Handler.
 *
--- a/cpukit/rtems/macros/rtems/rtems/options.inl
+++ b/cpukit/rtems/macros/rtems/rtems/options.inl
@@ -1,5 +1,8 @@
-/*  options.inl
- *
+/**
+ * @file rtems/rtems/options.inl
+ */
+
+/*
 *  This file contains the macro implementation of the inlined
 *  routines from the Options Handler.
 *
--- a/cpukit/rtems/macros/rtems/rtems/part.inl
+++ b/cpukit/rtems/macros/rtems/rtems/part.inl
@@ -1,5 +1,8 @@
-/*  part.inl
- *
+/**
+ * @file rtems/rtems/part.inl
+ */
+
+/*
 *  This file contains the macro implementation of all inlined routines
 *  in the Partition Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/ratemon.inl
+++ b/cpukit/rtems/macros/rtems/rtems/ratemon.inl
@@ -1,5 +1,8 @@
-/*  ratemon.inl
- *
+/**
+ * @file rtems/rtems/ratemon.inl
+ */
+
+/*
 *  This file contains the macro implementation of the inlined
 *  routines in the Rate Monotonic Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/region.inl
+++ b/cpukit/rtems/macros/rtems/rtems/region.inl
@@ -1,5 +1,8 @@
-/*  region.inl
- *
+/**
+ * @file rtems/rtems/region.inl
+ */
+
+/*
 *  This file contains the macro implementation of the inlined
 *  routines from the Region Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/sem.inl
+++ b/cpukit/rtems/macros/rtems/rtems/sem.inl
@@ -1,5 +1,8 @@
-/*  sem.inl
- *
+/**
+ * @file rtems/rtems/sem.inl
+ */
+
+/*
 *  This file contains the macro implementation of the inlined
 *  routines from the Semaphore Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/status.inl
+++ b/cpukit/rtems/macros/rtems/rtems/status.inl
@@ -1,5 +1,8 @@
-/*  macros/status.h
- *
+/**
+ * @file rtems/rtems/status.inl
+ */
+
+/*
 *  This include file contains the implementations of the inlined
 *  routines for the status package.
 *
--- a/cpukit/rtems/macros/rtems/rtems/support.inl
+++ b/cpukit/rtems/macros/rtems/rtems/support.inl
@@ -1,5 +1,8 @@
-/*  support.inl
- *
+/**
+ * @file rtems/rtems/support.inl
+ */
+
+/*
 *  This include file contains the macros implementation of all
 *  of the inlined routines specific to the RTEMS API.
 *
--- a/cpukit/rtems/macros/rtems/rtems/tasks.inl
+++ b/cpukit/rtems/macros/rtems/rtems/tasks.inl
@@ -1,5 +1,8 @@
-/*  tasks.inl
- *
+/**
+ * @file rtems/rtems/tasks.inl
+ */
+
+/*
 *  This file contains the macro implementation of all inlined
 *  routines in the with RTEMS Tasks Manager.
 *
--- a/cpukit/rtems/macros/rtems/rtems/timer.inl
+++ b/cpukit/rtems/macros/rtems/rtems/timer.inl
@@ -1,5 +1,8 @@
-/*  timer.inl
- *
+/**
+ * @file rtems/rtems/timer.inl
+ */
+
+/*
 *  This file contains the macro implementation of the inlined routines
 *  from the Timer Manager.
 *