summaryrefslogtreecommitdiffstats
path: root/cpukit
diff options
context:
space:
mode:
authorRalf Corsepius <ralf.corsepius@rtems.org>2004-11-21 07:42:11 +0000
committerRalf Corsepius <ralf.corsepius@rtems.org>2004-11-21 07:42:11 +0000
commitb96254f8dd6f0803f23557ab449f716738dbab87 (patch)
treefd9f10482d358f8abb4903faa12010dd0f5cabfa /cpukit
parent2004-11-21 Ralf Corsepius <ralf.corsepius@rtems.org> (diff)
downloadrtems-b96254f8dd6f0803f23557ab449f716738dbab87.tar.bz2
Add doxygen preamble.
Diffstat (limited to '')
-rw-r--r--cpukit/sapi/include/confdefs.h7
-rw-r--r--cpukit/sapi/include/rtems/config.h7
-rw-r--r--cpukit/sapi/include/rtems/extension.h7
-rw-r--r--cpukit/sapi/include/rtems/fatal.h7
-rw-r--r--cpukit/sapi/include/rtems/init.h9
-rw-r--r--cpukit/sapi/include/rtems/io.h7
-rw-r--r--cpukit/sapi/include/rtems/sptables.h8
-rw-r--r--cpukit/sapi/inline/rtems/extension.inl7
-rw-r--r--cpukit/sapi/macros/rtems/extension.inl7
9 files changed, 46 insertions, 20 deletions
diff --git a/cpukit/sapi/include/confdefs.h b/cpukit/sapi/include/confdefs.h
index 571f2423e0..8093c532a8 100644
--- a/cpukit/sapi/include/confdefs.h
+++ b/cpukit/sapi/include/confdefs.h
@@ -1,4 +1,5 @@
-/* confdefs.h
+/**
+ * @file rtems/confdefs.h
*
* This include file contains the configuration table template that will
* be instantiated by an application based on the setting of a number
@@ -22,7 +23,9 @@
* the above. This procedure has evolved from just enough to
* support the RTEMS Test Suites into something that can be
* used remarkably reliably by most applications.
- *
+ */
+
+/*
* COPYRIGHT (c) 1989-2002.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/sapi/include/rtems/config.h b/cpukit/sapi/include/rtems/config.h
index ca477d4571..74e7597d44 100644
--- a/cpukit/sapi/include/rtems/config.h
+++ b/cpukit/sapi/include/rtems/config.h
@@ -1,5 +1,8 @@
-/* config.h
- *
+/**
+ * @file rtems/config.h
+ */
+
+/*
* This include file contains the table of user defined configuration
* parameters.
*
diff --git a/cpukit/sapi/include/rtems/extension.h b/cpukit/sapi/include/rtems/extension.h
index 5b6d393620..868f73fe92 100644
--- a/cpukit/sapi/include/rtems/extension.h
+++ b/cpukit/sapi/include/rtems/extension.h
@@ -1,5 +1,8 @@
-/* extension.h
- *
+/**
+ * @file rtems/extension.h
+ */
+
+/*
* This include file contains all the constants, structures, and
* prototypes associated with the User Extension Manager. This manager
* provides a mechanism for manipulating sets of user-defined extensions.
diff --git a/cpukit/sapi/include/rtems/fatal.h b/cpukit/sapi/include/rtems/fatal.h
index 5f67bb4b2b..adc8c2e43b 100644
--- a/cpukit/sapi/include/rtems/fatal.h
+++ b/cpukit/sapi/include/rtems/fatal.h
@@ -1,5 +1,8 @@
-/* fatal.h
- *
+/**
+ * @file rtems/fatal.h
+ */
+
+/*
* This include file contains constants and prototypes related
* to the Fatal Error Manager. This manager processes all fatal or
* irrecoverable errors.
diff --git a/cpukit/sapi/include/rtems/init.h b/cpukit/sapi/include/rtems/init.h
index d17c17d5be..717927d81d 100644
--- a/cpukit/sapi/include/rtems/init.h
+++ b/cpukit/sapi/include/rtems/init.h
@@ -1,4 +1,6 @@
-/* init.h
+/**
+ * @file rtems/init.h
+ *
*
* This include file contains all the constants and structures associated
* with the Initialization Manager. This manager is responsible for
@@ -10,8 +12,9 @@
*
* + initialize the RTEMS executive
* + shutdown the RTEMS executive
- *
- *
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/sapi/include/rtems/io.h b/cpukit/sapi/include/rtems/io.h
index 8cdf687ae7..30ba5f7644 100644
--- a/cpukit/sapi/include/rtems/io.h
+++ b/cpukit/sapi/include/rtems/io.h
@@ -1,4 +1,5 @@
-/* io.h
+/**
+ * @file rtems/io.h
*
* This include file contains all the constants and structures associated
* with the Input/Output Manager. This manager provides a well defined
@@ -13,7 +14,9 @@
* + read from a device driver
* + write to a device driver
* + special device services
- *
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/sapi/include/rtems/sptables.h b/cpukit/sapi/include/rtems/sptables.h
index 93507ae250..0dc98c9c62 100644
--- a/cpukit/sapi/include/rtems/sptables.h
+++ b/cpukit/sapi/include/rtems/sptables.h
@@ -1,8 +1,11 @@
-/* sptables.h
+/**
+ * @file rtems/sptables.h
*
* This include file contains the executive's pre-initialized tables
* used when in a single processor configuration.
- *
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -68,4 +71,3 @@ extern const rtems_multiprocessing_table
#endif
#endif
-/* end of include file */
diff --git a/cpukit/sapi/inline/rtems/extension.inl b/cpukit/sapi/inline/rtems/extension.inl
index a7507b2306..c989acea48 100644
--- a/cpukit/sapi/inline/rtems/extension.inl
+++ b/cpukit/sapi/inline/rtems/extension.inl
@@ -1,8 +1,11 @@
-/* extension.inl
+/**
+ * @file rtems/extension.inl
*
* This file contains the static inline implementation of the inlined routines
* from the Extension Manager.
- *
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/sapi/macros/rtems/extension.inl b/cpukit/sapi/macros/rtems/extension.inl
index 2acb14114f..fea7635119 100644
--- a/cpukit/sapi/macros/rtems/extension.inl
+++ b/cpukit/sapi/macros/rtems/extension.inl
@@ -1,8 +1,11 @@
-/* extension.inl
+/**
+ * @file rtems/extension.inl
*
* This file contains the macro implementation of the inlined routines
* from the Extension Manager.
- *
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*