summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRalf Corsepius <ralf.corsepius@rtems.org>2004-11-02 09:56:13 +0000
committerRalf Corsepius <ralf.corsepius@rtems.org>2004-11-02 09:56:13 +0000
commitd964f79f462659ddb37053b345d0dc5418c0b175 (patch)
tree23ff4e70dd695d7312fa8f8beedb8e6d7132036f
parent4b48736344336a4c93d7f524730e7ac696c30b6f (diff)
downloadrtems-d964f79f462659ddb37053b345d0dc5418c0b175.tar.bz2
Add doxygen preamble.
-rw-r--r--cpukit/rtems/include/rtems.h7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/asr.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/attr.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/dpmem.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/event.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/eventset.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/message.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/modes.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/options.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/part.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/ratemon.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/region.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/sem.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/status.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/support.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/tasks.inl7
-rw-r--r--cpukit/rtems/inline/rtems/rtems/timer.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/asr.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/attr.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/dpmem.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/event.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/eventset.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/message.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/modes.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/options.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/part.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/ratemon.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/region.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/sem.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/status.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/support.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/tasks.inl7
-rw-r--r--cpukit/rtems/macros/rtems/rtems/timer.inl7
33 files changed, 165 insertions, 66 deletions
diff --git a/cpukit/rtems/include/rtems.h b/cpukit/rtems/include/rtems.h
index 0b70566ec3..0968ef455d 100644
--- 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
diff --git a/cpukit/rtems/inline/rtems/rtems/asr.inl b/cpukit/rtems/inline/rtems/rtems/asr.inl
index e7bd708f6a..3eb5cde204 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/attr.inl b/cpukit/rtems/inline/rtems/rtems/attr.inl
index b58a0f95df..beb309c4de 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/dpmem.inl b/cpukit/rtems/inline/rtems/rtems/dpmem.inl
index 6721d942d4..72bf892bdb 100644
--- 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
*
diff --git a/cpukit/rtems/inline/rtems/rtems/event.inl b/cpukit/rtems/inline/rtems/rtems/event.inl
index 34bc51e898..fec2c4b7be 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/eventset.inl b/cpukit/rtems/inline/rtems/rtems/eventset.inl
index 5baf074664..ea253d3d8f 100644
--- 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.
diff --git a/cpukit/rtems/inline/rtems/rtems/message.inl b/cpukit/rtems/inline/rtems/rtems/message.inl
index fd8832bf20..35ddd2f45e 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/modes.inl b/cpukit/rtems/inline/rtems/rtems/modes.inl
index bffe2df1fb..95571305d9 100644
--- 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
*
diff --git a/cpukit/rtems/inline/rtems/rtems/options.inl b/cpukit/rtems/inline/rtems/rtems/options.inl
index e9a4849d30..8b046bca3e 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/part.inl b/cpukit/rtems/inline/rtems/rtems/part.inl
index 009a946401..0f6cb2c975 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/ratemon.inl b/cpukit/rtems/inline/rtems/rtems/ratemon.inl
index 8084277204..d42eb13f9f 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/region.inl b/cpukit/rtems/inline/rtems/rtems/region.inl
index 721d89c110..a4c7e6d2ab 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/sem.inl b/cpukit/rtems/inline/rtems/rtems/sem.inl
index 4c15a99792..a83eb8bde2 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/status.inl b/cpukit/rtems/inline/rtems/rtems/status.inl
index 01cd778373..a648862899 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/support.inl b/cpukit/rtems/inline/rtems/rtems/support.inl
index 53a86aa056..cb1adac729 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/tasks.inl b/cpukit/rtems/inline/rtems/rtems/tasks.inl
index 32295570c6..84b316f00b 100644
--- 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.
*
diff --git a/cpukit/rtems/inline/rtems/rtems/timer.inl b/cpukit/rtems/inline/rtems/rtems/timer.inl
index afad51ed32..ad24f475ce 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/asr.inl b/cpukit/rtems/macros/rtems/rtems/asr.inl
index 0f39178146..60fce8c1b6 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/attr.inl b/cpukit/rtems/macros/rtems/rtems/attr.inl
index 37e566913b..9d52ace999 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/dpmem.inl b/cpukit/rtems/macros/rtems/rtems/dpmem.inl
index af35e1a448..b5ca14f5fe 100644
--- 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
*
diff --git a/cpukit/rtems/macros/rtems/rtems/event.inl b/cpukit/rtems/macros/rtems/rtems/event.inl
index 3762e91e05..f4467a3cea 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/eventset.inl b/cpukit/rtems/macros/rtems/rtems/eventset.inl
index 1a265cc4af..e4ca261a2e 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/message.inl b/cpukit/rtems/macros/rtems/rtems/message.inl
index af81086f42..6f31e3a662 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/modes.inl b/cpukit/rtems/macros/rtems/rtems/modes.inl
index 7077604746..d8e98cd13b 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/options.inl b/cpukit/rtems/macros/rtems/rtems/options.inl
index a9f4a2c464..727856b810 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/part.inl b/cpukit/rtems/macros/rtems/rtems/part.inl
index 0aab6545c1..2d809294db 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/ratemon.inl b/cpukit/rtems/macros/rtems/rtems/ratemon.inl
index 03e1c7f481..353be34720 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/region.inl b/cpukit/rtems/macros/rtems/rtems/region.inl
index 56969816c7..bf63c6d1cf 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/sem.inl b/cpukit/rtems/macros/rtems/rtems/sem.inl
index b49df036c4..1a4797ce7a 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/status.inl b/cpukit/rtems/macros/rtems/rtems/status.inl
index fb4ee72b8e..8508a80a68 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/support.inl b/cpukit/rtems/macros/rtems/rtems/support.inl
index a0239ecfbc..c0cc8a53ab 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/tasks.inl b/cpukit/rtems/macros/rtems/rtems/tasks.inl
index 8c044d873e..e7f2b21119 100644
--- 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.
*
diff --git a/cpukit/rtems/macros/rtems/rtems/timer.inl b/cpukit/rtems/macros/rtems/rtems/timer.inl
index 3043e7de21..6092db1ebb 100644
--- 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.
*