summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-04-27 16:14:06 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-04-28 09:04:00 +0200
commitcfe8f7a9b7e23590760874992fc461fe4a74964c (patch)
treeafa921338735c3ff03a14bdf5382b1e93d73d4da /cpukit/libmisc
parentlibdl/mips: Fix MIPS16hi/lo relocation support. (diff)
downloadrtems-cfe8f7a9b7e23590760874992fc461fe4a74964c.tar.bz2
doxygen: Switch @brief and @ingroup
This order change fixes the Latex documentation build via Doxygen.
Diffstat (limited to 'cpukit/libmisc')
-rw-r--r--cpukit/libmisc/bspcmdline/bspcmdline_get.c3
-rw-r--r--cpukit/libmisc/bspcmdline/bspcmdline_getparam.c3
-rw-r--r--cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c3
-rw-r--r--cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c3
-rw-r--r--cpukit/libmisc/cpuuse/cpuusagedata.c3
-rw-r--r--cpukit/libmisc/cpuuse/cpuusagereport.c3
-rw-r--r--cpukit/libmisc/cpuuse/cpuusagereset.c3
-rw-r--r--cpukit/libmisc/cpuuse/cpuusagetop.c3
-rw-r--r--cpukit/libmisc/devnull/devnull.c3
-rw-r--r--cpukit/libmisc/devnull/devzero.c3
-rw-r--r--cpukit/libmisc/dumpbuf/dumpbuf.c3
-rw-r--r--cpukit/libmisc/fb/mw_print.c3
-rw-r--r--cpukit/libmisc/fb/mw_uid.c3
-rw-r--r--cpukit/libmisc/fsmount/fsmount.c3
-rw-r--r--cpukit/libmisc/mouse/mouse_parser.c3
-rw-r--r--cpukit/libmisc/mouse/serial_mouse.c3
-rw-r--r--cpukit/libmisc/shell/main_df.c3
-rw-r--r--cpukit/libmisc/stackchk/check.c3
-rw-r--r--cpukit/libmisc/stringto/stringtodouble.c3
-rw-r--r--cpukit/libmisc/stringto/stringtofloat.c3
-rw-r--r--cpukit/libmisc/stringto/stringtoint.c3
-rw-r--r--cpukit/libmisc/stringto/stringtolong.c3
-rw-r--r--cpukit/libmisc/stringto/stringtolongdouble.c3
-rw-r--r--cpukit/libmisc/stringto/stringtolonglong.c3
-rw-r--r--cpukit/libmisc/stringto/stringtopointer.c3
-rw-r--r--cpukit/libmisc/stringto/stringtounsignedchar.c3
-rw-r--r--cpukit/libmisc/stringto/stringtounsignedint.c3
-rw-r--r--cpukit/libmisc/stringto/stringtounsignedlong.c3
-rw-r--r--cpukit/libmisc/stringto/stringtounsignedlonglong.c3
29 files changed, 58 insertions, 29 deletions
diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_get.c b/cpukit/libmisc/bspcmdline/bspcmdline_get.c
index c518484e15..029cb6b8e6 100644
--- a/cpukit/libmisc/bspcmdline/bspcmdline_get.c
+++ b/cpukit/libmisc/bspcmdline/bspcmdline_get.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Obtain Pointer to BSP Boot Command String
* @ingroup BSPCommandLine BSP Command Line Helpers
+ *
+ * @brief Obtain Pointer to BSP Boot Command String
*/
/*
diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c b/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c
index 63da02dac3..f18773a49a 100644
--- a/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c
+++ b/cpukit/libmisc/bspcmdline/bspcmdline_getparam.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Obtain COPY of the Entire Matching Argument
* @ingroup BSPCommandLine BSP Command Line Helpers
+ *
+ * @brief Obtain COPY of the Entire Matching Argument
*/
/*
diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c b/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c
index d1f11c7bec..db4a01aed3 100644
--- a/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c
+++ b/cpukit/libmisc/bspcmdline/bspcmdline_getparamraw.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Obtain Pointer to the Entire Matching Argument
* @ingroup BSPCommandLine BSP Command Line Helpers
+ *
+ * @brief Obtain Pointer to the Entire Matching Argument
*/
/*
diff --git a/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c b/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c
index 4bfe062afe..aab5b02850 100644
--- a/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c
+++ b/cpukit/libmisc/bspcmdline/bspcmdline_getparamrhs.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Obtain COPY of the Right Hand Side of the Matching Argument
* @ingroup BSPCommandLine BSP Command Line Helpers
+ *
+ * @brief Obtain COPY of the Right Hand Side of the Matching Argument
*/
/*
diff --git a/cpukit/libmisc/cpuuse/cpuusagedata.c b/cpukit/libmisc/cpuuse/cpuusagedata.c
index d855a4da90..0d06dd3e5c 100644
--- a/cpukit/libmisc/cpuuse/cpuusagedata.c
+++ b/cpukit/libmisc/cpuuse/cpuusagedata.c
@@ -1,9 +1,10 @@
/**
* @file
*
- * @brief CPU Usage Data
* @ingroup libmisc_cpuuse CPU Usage
*
+ * @brief CPU Usage Data
+ *
* CPU Usage Reporter - Shared Data
*/
diff --git a/cpukit/libmisc/cpuuse/cpuusagereport.c b/cpukit/libmisc/cpuuse/cpuusagereport.c
index 2a01a8aa3d..08bc5bb541 100644
--- a/cpukit/libmisc/cpuuse/cpuusagereport.c
+++ b/cpukit/libmisc/cpuuse/cpuusagereport.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief CPU Usage Report
* @ingroup libmisc_cpuuse CPU Usage
+ *
+ * @brief CPU Usage Report
*/
/*
diff --git a/cpukit/libmisc/cpuuse/cpuusagereset.c b/cpukit/libmisc/cpuuse/cpuusagereset.c
index 455651e19f..10d8ebec48 100644
--- a/cpukit/libmisc/cpuuse/cpuusagereset.c
+++ b/cpukit/libmisc/cpuuse/cpuusagereset.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief CPU Usage Reset
* @ingroup libmisc_cpuuse CPU Usage
+ *
+ * @brief CPU Usage Reset
*/
/*
diff --git a/cpukit/libmisc/cpuuse/cpuusagetop.c b/cpukit/libmisc/cpuuse/cpuusagetop.c
index 66cbda9277..9f19b27439 100644
--- a/cpukit/libmisc/cpuuse/cpuusagetop.c
+++ b/cpukit/libmisc/cpuuse/cpuusagetop.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief CPU Usage Top
* @ingroup libmisc_cpuuse CPU Usage
+ *
+ * @brief CPU Usage Top
*/
/*
diff --git a/cpukit/libmisc/devnull/devnull.c b/cpukit/libmisc/devnull/devnull.c
index 6ec70e85a4..9adc47c665 100644
--- a/cpukit/libmisc/devnull/devnull.c
+++ b/cpukit/libmisc/devnull/devnull.c
@@ -1,9 +1,10 @@
/**
* @file
*
- * @brief Null Device Driver Init Routine
* @ingroup libmisc_devnull Device Driver
*
+ * @brief Null Device Driver Init Routine
+ *
* Derived from rtems' stub driver.
*/
diff --git a/cpukit/libmisc/devnull/devzero.c b/cpukit/libmisc/devnull/devzero.c
index 4aecec6528..a993e5c810 100644
--- a/cpukit/libmisc/devnull/devzero.c
+++ b/cpukit/libmisc/devnull/devzero.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Devzero
* @ingroup libmisc_devnull Device Driver
+ *
+ * @brief Devzero
*/
/*
diff --git a/cpukit/libmisc/dumpbuf/dumpbuf.c b/cpukit/libmisc/dumpbuf/dumpbuf.c
index ed4868cdb4..7f8128259f 100644
--- a/cpukit/libmisc/dumpbuf/dumpbuf.c
+++ b/cpukit/libmisc/dumpbuf/dumpbuf.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Dump Buffer
* @ingroup libmisc_dumpbuf Print Memory Buffer
+ *
+ * @brief Dump Buffer
*/
/*
diff --git a/cpukit/libmisc/fb/mw_print.c b/cpukit/libmisc/fb/mw_print.c
index 1d226b7d0f..34979960c9 100644
--- a/cpukit/libmisc/fb/mw_print.c
+++ b/cpukit/libmisc/fb/mw_print.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief MicroWindows Print
* @ingroup libmisc_fb_mw Input Devices for MicroWindows
+ *
+ * @brief MicroWindows Print
*/
/*
diff --git a/cpukit/libmisc/fb/mw_uid.c b/cpukit/libmisc/fb/mw_uid.c
index db98f1fa9c..c3933d6e99 100644
--- a/cpukit/libmisc/fb/mw_uid.c
+++ b/cpukit/libmisc/fb/mw_uid.c
@@ -1,9 +1,10 @@
/**
* @file
*
- * @brief MicroWindows UID
* @ingroup libmisc_fb_mw Input Devices for MicroWindows
*
+ * @brief MicroWindows UID
+ *
* This module implements the input devices interface used by MicroWindows
* in an embedded system environment. It uses the RTEMS message queue as
* the repository for the messages posted by the devices registered.
diff --git a/cpukit/libmisc/fsmount/fsmount.c b/cpukit/libmisc/fsmount/fsmount.c
index 91b57388c1..190d0dd511 100644
--- a/cpukit/libmisc/fsmount/fsmount.c
+++ b/cpukit/libmisc/fsmount/fsmount.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief File System Mount Functions
* @ingroup rtems_fstab File System Mount Support
+ *
+ * @brief File System Mount Functions
*/
/*
diff --git a/cpukit/libmisc/mouse/mouse_parser.c b/cpukit/libmisc/mouse/mouse_parser.c
index 573e6cf5fd..5701dcd9f5 100644
--- a/cpukit/libmisc/mouse/mouse_parser.c
+++ b/cpukit/libmisc/mouse/mouse_parser.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Opens a Serial Port Directly, and Interprets Serial Data
* @ingroup libmisc_mouse Mouse Parser Engine
+ *
+ * @brief Opens a Serial Port Directly, and Interprets Serial Data
*/
/*
diff --git a/cpukit/libmisc/mouse/serial_mouse.c b/cpukit/libmisc/mouse/serial_mouse.c
index 874903a607..53a174df57 100644
--- a/cpukit/libmisc/mouse/serial_mouse.c
+++ b/cpukit/libmisc/mouse/serial_mouse.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Serial Mouse Driver
* @ingroup libmisc_mouse Serial Mouse Driver
+ *
+ * @brief Serial Mouse Driver
*/
/*
diff --git a/cpukit/libmisc/shell/main_df.c b/cpukit/libmisc/shell/main_df.c
index ac1d5f6452..d4266147a6 100644
--- a/cpukit/libmisc/shell/main_df.c
+++ b/cpukit/libmisc/shell/main_df.c
@@ -1,8 +1,9 @@
/**
* df Shell Command Implmentation
*
- * @brief Obtain MS-DOS filesystem information
* @ingroup libfs_msdos MSDOS FileSystem
+ *
+ * @brief Obtain MS-DOS filesystem information
*/
/*
diff --git a/cpukit/libmisc/stackchk/check.c b/cpukit/libmisc/stackchk/check.c
index 0c859f6375..ab08155c92 100644
--- a/cpukit/libmisc/stackchk/check.c
+++ b/cpukit/libmisc/stackchk/check.c
@@ -1,9 +1,10 @@
/**
* @file
*
- * @brief Stack Overflow Check User Extension Set
* @ingroup libmisc_stackchk Stack Checker Mechanism
*
+ * @brief Stack Overflow Check User Extension Set
+ *
* NOTE: This extension set automatically determines at
* initialization time whether the stack for this
* CPU grows up or down and installs the correct
diff --git a/cpukit/libmisc/stringto/stringtodouble.c b/cpukit/libmisc/stringto/stringtodouble.c
index 169719c210..c3cd851077 100644
--- a/cpukit/libmisc/stringto/stringtodouble.c
+++ b/cpukit/libmisc/stringto/stringtodouble.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Double (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Double (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtofloat.c b/cpukit/libmisc/stringto/stringtofloat.c
index 2c3d407f7a..46326af960 100644
--- a/cpukit/libmisc/stringto/stringtofloat.c
+++ b/cpukit/libmisc/stringto/stringtofloat.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Float (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Float (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtoint.c b/cpukit/libmisc/stringto/stringtoint.c
index 16b95d02e1..fdd85cad3d 100644
--- a/cpukit/libmisc/stringto/stringtoint.c
+++ b/cpukit/libmisc/stringto/stringtoint.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Int (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Int (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtolong.c b/cpukit/libmisc/stringto/stringtolong.c
index 2c6abb96e8..7f5fa0b5aa 100644
--- a/cpukit/libmisc/stringto/stringtolong.c
+++ b/cpukit/libmisc/stringto/stringtolong.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Long (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Long (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtolongdouble.c b/cpukit/libmisc/stringto/stringtolongdouble.c
index e403653b80..754e0b11e7 100644
--- a/cpukit/libmisc/stringto/stringtolongdouble.c
+++ b/cpukit/libmisc/stringto/stringtolongdouble.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to long double (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to long double (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtolonglong.c b/cpukit/libmisc/stringto/stringtolonglong.c
index 11f259cd2a..c35188529e 100644
--- a/cpukit/libmisc/stringto/stringtolonglong.c
+++ b/cpukit/libmisc/stringto/stringtolonglong.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Long Long (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Long Long (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtopointer.c b/cpukit/libmisc/stringto/stringtopointer.c
index ecc4beabd9..5d69768742 100644
--- a/cpukit/libmisc/stringto/stringtopointer.c
+++ b/cpukit/libmisc/stringto/stringtopointer.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Pointer (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Pointer (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtounsignedchar.c b/cpukit/libmisc/stringto/stringtounsignedchar.c
index fbaa1cdfc6..6181cfeeaa 100644
--- a/cpukit/libmisc/stringto/stringtounsignedchar.c
+++ b/cpukit/libmisc/stringto/stringtounsignedchar.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Unsigned Character (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Unsigned Character (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtounsignedint.c b/cpukit/libmisc/stringto/stringtounsignedint.c
index 15ffe495fa..95c6c85ac9 100644
--- a/cpukit/libmisc/stringto/stringtounsignedint.c
+++ b/cpukit/libmisc/stringto/stringtounsignedint.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Unsigned Int (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Unsigned Int (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtounsignedlong.c b/cpukit/libmisc/stringto/stringtounsignedlong.c
index 5a9b57075a..16f109735e 100644
--- a/cpukit/libmisc/stringto/stringtounsignedlong.c
+++ b/cpukit/libmisc/stringto/stringtounsignedlong.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Unsigned Long Long (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Unsigned Long Long (with validation)
*/
/*
diff --git a/cpukit/libmisc/stringto/stringtounsignedlonglong.c b/cpukit/libmisc/stringto/stringtounsignedlonglong.c
index 28cd20d395..5dd9628166 100644
--- a/cpukit/libmisc/stringto/stringtounsignedlonglong.c
+++ b/cpukit/libmisc/stringto/stringtounsignedlonglong.c
@@ -1,8 +1,9 @@
/**
* @file
*
- * @brief Convert String to Unsigned Long Long (with validation)
* @ingroup libmisc_conv_help Conversion Helpers
+ *
+ * @brief Convert String to Unsigned Long Long (with validation)
*/
/*