From a15eaaf9fdba8a9311623ae44711d17701a19d30 Mon Sep 17 00:00:00 2001
From: Joel Sherrill <joel.sherrill@oarcorp.com>
Date: Thu, 10 Jan 2013 13:20:34 -0600
Subject: cpukit: Doxygen group fixes and many warnings addressed

The output of the modules.html is much improved. Most
filesystem and POSIX API related groups are properly nested.
Some formatting issues were addressed as were multiple
inconsistencies.
---
 cpukit/libcsupport/include/console.h        |  2 +-
 cpukit/libcsupport/include/rtems/deviceio.h | 20 ++++++++++----------
 cpukit/libcsupport/include/rtems/error.h    | 14 +++++++++-----
 cpukit/libcsupport/include/sys/utsname.h    |  8 +++++---
 4 files changed, 25 insertions(+), 19 deletions(-)

(limited to 'cpukit/libcsupport')

diff --git a/cpukit/libcsupport/include/console.h b/cpukit/libcsupport/include/console.h
index 9cd0e9651f..6b8b8c9455 100644
--- a/cpukit/libcsupport/include/console.h
+++ b/cpukit/libcsupport/include/console.h
@@ -47,7 +47,7 @@ extern "C" {
  * @param[in] major is the device driver major number.
  * @param[in] minor is the device driver minor number.
  * @param[in] arg is the parameters to this call.
- *.
+ *
  * @retval RTEMS_SUCCESSFUL The device driver is successfully initialized.
  */
 rtems_device_driver console_initialize(
diff --git a/cpukit/libcsupport/include/rtems/deviceio.h b/cpukit/libcsupport/include/rtems/deviceio.h
index df78852bb4..571b3e14ec 100644
--- a/cpukit/libcsupport/include/rtems/deviceio.h
+++ b/cpukit/libcsupport/include/rtems/deviceio.h
@@ -1,8 +1,7 @@
 /**
  * @file
  *
- * @brief Map Operations on IMFS Device Nodes to the RTEMS Classic API
- * IO Manager
+ * @brief Operations on IMFS Device Nodes 
  */
 
 /*
@@ -17,14 +16,16 @@
 #ifndef _RTEMS_DEVICEIO_H
 #define _RTEMS_DEVICEIO_H
 
+#include <rtems/libio.h>
+
 /**
- *  @defgroup Device IO Handler
- * 
+ *  @defgroup IMFSDevices IMFS Device IO Handler
  * 
- * @{
+ *  @ingroup IMFS
+ *
+ *  This contains the interface to device drivers using the RTEMS Classic API.
  */
-
-#include <rtems/libio.h>
+/**@{*/
 
 #ifdef __cplusplus
 extern "C" {
@@ -79,12 +80,11 @@ int rtems_deviceio_control(
   rtems_device_minor_number minor
 );
 
-/** @} */
-
 #ifdef __cplusplus
 }
 #endif
-
 /* __cplusplus */
 
+/**@}*/
+
 #endif /* _RTEMS_DEVICEIO_H */
diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h
index 31a37e025b..4eae14f912 100644
--- a/cpukit/libcsupport/include/rtems/error.h
+++ b/cpukit/libcsupport/include/rtems/error.h
@@ -20,27 +20,32 @@
  * It can also include a rtems_status value which can be OR'd
  * with the above flags. *
  *
- * EXAMPLE
+ * Example 1:
+ * @code
  *  #include <rtems.h>
  *  #include <rtems/error.h>
  *  rtems_error(0, "stray interrupt %d", intr);
+ * @endcode
  *
- * EXAMPLE
+ * Example 2:
+ * @code
  *        if ((status = rtems_task_create(...)) != RTEMS_SUCCCESSFUL)
  *        {
  *            rtems_error(status | RTEMS_ERROR_ABORT,
  *                        "could not create task");
  *        }
+ * @endcode
  *
- * EXAMPLE
+ * Example 3:
+ * @code
  *        if ((fd = open(pathname, O_RDNLY)) < 0)
  *        {
  *            rtems_error(RTEMS_ERROR_ERRNO, "open of '%s' failed", pathname);
  *            goto failed;
  *        }
+ * @endcode
  */
 
-
 #ifndef _RTEMS_RTEMS_ERROR_H
 #define _RTEMS_RTEMS_ERROR_H
 
@@ -59,7 +64,6 @@ extern "C" {
  *  @brief Defines and externs for rtems error reporting
  *
  */
-
 typedef Internal_errors_t rtems_error_code_t;
 
 /*
diff --git a/cpukit/libcsupport/include/sys/utsname.h b/cpukit/libcsupport/include/sys/utsname.h
index 93d331637e..2bad0e2572 100644
--- a/cpukit/libcsupport/include/sys/utsname.h
+++ b/cpukit/libcsupport/include/sys/utsname.h
@@ -19,10 +19,11 @@
 #define __POSIX_SYS_UTSNAME_h
 
 /**
- * @defgroup utsname Service
+ * @defgroup UTSNAME utsname Service
  * 
- * @{
+ * @ingroup POSIXAPI
  */
+/**@{*/
 
 #ifdef __cplusplus
 extern "C" {
@@ -46,7 +47,8 @@ extern "C" {
 #endif
 
 struct utsname {
-  char sysname[SYS_NMLN];  /* Name of this implementation of the operating system */
+  char sysname[SYS_NMLN];  /* Name of this implementation of the */
+                           /*   operating system */
   char nodename[SYS_NMLN]; /* Name of this node within an implementation */
                            /*   specified communication network */
   char release[SYS_NMLN];  /* Current release level of this implementation */
-- 
cgit v1.2.3