libmisc: Doxygen Clean Up Task #1

Conflicts occured durning this patch and modifications in
the repo were favored over the patch.

cpukit/libmisc/bspcmdline/bspcmdline.h

@@ -1,8 +1,10 @@
 /**
  * @file rtems/bspcmdline.h
  *
- *  @brief Related Prototypes and Specifications to
+ * @defgroup BSPCommandLine BSP Command Line Helpers
- *  BSP Command Line String and helper routines.
+ *
+ * @ingroup libmisc
+ * @brief BSP Command Line Handler
  *
  * This include file contains all prototypes and specifications
  * related to the BSP Command Line String and associated helper
@@ -46,7 +48,7 @@ extern "C" {
  * is as likely to be NULL as point to a string as most BSPs do not
  * have a start environment that provides a boot string.
  *
- *  @return This method returns the pointer to the BSP Boot Command String.
+ * @retval This method returns the pointer to the BSP Boot Command String.
  */
 const char *rtems_bsp_cmdline_get(void);
 
@@ -90,7 +92,7 @@ const char *rtems_bsp_cmdline_get_param(
  *            be placed if located.
  * @param[in] length is the maximum length to copy
  *
- *  @return This method returns NULL if not found and
+ * @retval This method returns NULL if not found and
  *         @a value if found.
  */
 const char *rtems_bsp_cmdline_get_param_rhs(
@@ -111,7 +113,7 @@ const char *rtems_bsp_cmdline_get_param_rhs(
  *
  * @param[in] name is the arugment to search for
  *
- *  @return This method returns NULL if not found and a pointer
+ * @retval This method returns NULL if not found and a pointer
  *         into the BSP Boot Command String if found.
  *
  * @note The pointer will be to the original BSP Command

cpukit/libmisc/cpuuse/cpuuse.h

@@ -1,8 +1,10 @@
 /**
  * @file rtems/cpuuse.h
  * 
- * @brief Information Necessary to Utilize
+ * @defgroup libmisc_cpuuse CPU Usage
- * and Install the CPU Usage Reporting Mechanism
+ *
+ * @ingroup libmisc
+ * @brief CPU Usage Report
  *
  * This include file contains information necessary to utilize
  * and install the cpu usage reporting mechanism.

cpukit/libmisc/devnull/devzero.h

@@ -1,7 +1,10 @@
 /**
  * @file rtems/devzero.h
  *
- * @brief Interface to the RTEMS /dev/zero Device Driver
+ * @defgroup libmisc_devzero Device Driver
+ *
+ * @ingroup libmisc
+ * @brief RTEMS /dev/zero Device Driver
  *
  * This include file defines the interface to the RTEMS /dev/zero
  * device driver.

cpukit/libmisc/fb/fb.h

@@ -1,4 +1,10 @@
-/** @file rtems/fb.h
+/** 
+ * @file rtems/fb.h
+ *
+ * @defgroup libmisc_fb Device Driver
+ *
+ * @ingroup libmisc
+ * @brief Frame Buffer Device Driver
  *
  * This file defines the interface to a frame buffer device driver.
  */

cpukit/libmisc/fb/mw_uid.h

@@ -1,11 +1,13 @@
 /**
  * @file rtems/mw_uid.h
  *
- * @brief Input device Interface for MicroWindows in an
+ * @defgroup libmisc_fb_mw Input Devices for MicroWindows
- * Embedded System Enviroment
  *
- * This file defines the interface for input devices used by
+ * @ingroup libmisc
- * MicroWindows in an embedded system environment.
+ * @brief Input Devices for MicroWindows
+ *
+ * This file defines the interface for input devices used by MicroWindows
+ * in an embedded system environment.
  */
 
 /*
@@ -121,14 +123,14 @@ struct MW_UID_MESSAGE {
  *
  * @note The message queue is from the Classic API.
  *
- *  @return This method returns 0 on success and -1 on error.
+ * @retval This method returns 0 on success and -1 on error.
  */
 extern int uid_open_queue( const char *q_name, int flags, size_t max_msgs );
 
 /**
  * This method closes the message queue and deletes it.
  *
- *  @return This method returns 0 on success and -1 on error.
+ * @retval This method returns 0 on success and -1 on error.
  */
 extern int uid_close_queue( void );
 
@@ -139,7 +141,7 @@ extern int uid_close_queue( void );
  * @param[in] m will be filled in with the received message
  * @param[in] timeout is the maximum number of mulliseconds to wait
  *
- *  @return This method returns 0 on success and -1 on error.
+ * @retval This method returns 0 on success and -1 on error.
  */
 extern int uid_read_message( struct MW_UID_MESSAGE *m, unsigned long timeout );
 
@@ -148,7 +150,7 @@ extern int uid_read_message( struct MW_UID_MESSAGE *m, unsigned long timeout );
  *
  * @param[in] m is the message to send
  *
- *  @return This method returns 0 on success and -1 on error.
+ * @retval This method returns 0 on success and -1 on error.
  */
 extern int uid_send_message( struct MW_UID_MESSAGE *m );
 

cpukit/libmisc/fsmount/fsmount.h

@@ -1,7 +1,27 @@
 /**
- * @file
+ * @file rtems/fsmount.h
  *
- * File system mount functions.
+ * @defgroup rtems_fstab File System Mount Support
+ *
+ * @ingroup FileSystemTypesAndMount
+ * @brief File System Mount Functions
+ *
+ * This file contains the fsmount functions. These functions       
+ * are used to mount a list of filesystems (and create their mount 
+ * points before)
+  */
+
+/*
+ *
+ * Copyright (c) 2003 IMD
+ *    
+ * Ingenieurbuero fuer Microcomputertechnik Th. Doerfler      
+ * <Thomas.Doerfler@imd-systems.de>                  
+ * all rights reserved
+ *                    
+ * The license and distribution terms for this file may be        
+ * found in the file LICENSE in this distribution or at           
+ * http://www.rtems.com/license/LICENSE. 
  */
  
 /*===============================================================*\

cpukit/libmisc/mouse/mouse_parser.h

@@ -1,7 +1,10 @@
 /**
  * @file rtems/mouse_parser.h
  *
- * @brief Mouse Parser Engine
+ * @defgroup libmisc_mouse Mouse Parser Engine
+ *
+ * @ingroup libmisc
+ * @brief Initialize Mouse Parser Engine
  *
  * This file is the header file for the Mouse Parser Engine.
  */
@@ -97,7 +100,7 @@ typedef void (*mouse_parser_enqueue_handler)(unsigned char *, size_t);
  *
  * @a param[in] type indicates the type of mouse.
  *
- *  @return This method returns 0 on success and -1 on error.
+ * @retval This method returns 0 on success and -1 on error.
  */
 int mouse_parser_initialize(const char *type);
 

cpukit/libmisc/mouse/serial_mouse.h

@@ -148,7 +148,7 @@ rtems_device_driver serial_mouse_control(
  *            of the serial port with the mouse connected.
  * @param[in] type will point to a string with the type of mouse connected.
  *
- *  @return This method returns true on success and false on error.
+ * @retval This method returns true on success and false on error.
  */
 bool bsp_get_serial_mouse_device(
   const char **name,

cpukit/libmisc/stackchk/internal.h

@@ -1,8 +1,16 @@
-/*  internal.h
+/*  
+ * @file rtems/internal.h
+ *
+ * @defgroup libmisc_internal Internal Stack Checker Information
+ *
+ * @ingroup libmisc
+ * @brief Stack Checker Internal Information
  *  
  * This include file contains internal information
  * for the RTEMS stack checker.
- *
+ */
+
+/*
  * COPYRIGHT (c) 1989-2006.
  * On-Line Applications Research Corporation (OAR).
  *

cpukit/libmisc/stackchk/stackchk.h

@@ -1,8 +1,10 @@
 /**
  * @file rtems/stackchk.h
  *
- * @brief Information Necessary to Utilize and Install the
+ * @defgroup libmisc_stackchk Stack Checker Mechanism
- * Stack Checker Mechanism
+ *
+ * @ingroup libmisc
+ * @brief Stack Checker Information
  *
  * This include file contains information necessary to utilize
  * and install the stack checker mechanism.
@@ -41,7 +43,7 @@ extern "C" {
  * This method is used to determine if the current stack pointer
  * of the currently executing task is within bounds.
  *
- *  @return This method returns true if the currently executing task
+ * @retval This method returns true if the currently executing task
  * has blown its stack.
  *
  */

cpukit/libmisc/stringto/stringto.h

@@ -1,6 +1,11 @@
 /**
  * @file rtems/stringto.h
  *
+ * @defgroup libmisc_conv_help Conversion Helpers
+ *
+ * @ingroup libmisc
+ * @brief Convert String to Pointer (with validation)
+ *
  * This file defines the interface to a set of string conversion helpers.
  */
 
@@ -34,7 +39,7 @@
  * @param[in] n points to the variable to place the converted output in
  * @param[in] endptr is used to keep track of the position in the string
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -55,7 +60,7 @@ rtems_status_code rtems_string_to_pointer(
  * @param[in] endptr is used to keep track of the position in the string
  * @param[in] base is the expected base of the number
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -76,7 +81,7 @@ rtems_status_code rtems_string_to_unsigned_char(
  * @param[in] endptr is used to keep track of the position in the string
  * @param[in] base is the expected base of the number
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -97,7 +102,7 @@ rtems_status_code rtems_string_to_int(
  * @param[in] endptr is used to keep track of the position in the string
  * @param[in] base is the expected base of the number
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -119,7 +124,7 @@ rtems_status_code rtems_string_to_unsigned_int(
  * @param[in] endptr is used to keep track of the position in the string
  * @param[in] base is the expected base of the number
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -141,7 +146,7 @@ rtems_status_code rtems_string_to_long(
  * @param[in] endptr is used to keep track of the position in the string
  * @param[in] base is the expected base of the number
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -163,7 +168,7 @@ rtems_status_code rtems_string_to_unsigned_long(
  * @param[in] endptr is used to keep track of the position in the string
  * @param[in] base is the expected base of the number
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -185,7 +190,7 @@ rtems_status_code rtems_string_to_long_long(
  * @param[in] endptr is used to keep track of the position in the string
  * @param[in] base is the expected base of the number
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -205,7 +210,7 @@ rtems_status_code rtems_string_to_unsigned_long_long(
  * @param[in] n points to the variable to place the converted output in
  * @param[in] endptr is used to keep track of the position in the string
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -224,7 +229,7 @@ rtems_status_code rtems_string_to_float(
  * @param[in] n points to the variable to place the converted output in
  * @param[in] endptr is used to keep track of the position in the string
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */
@@ -243,7 +248,7 @@ rtems_status_code rtems_string_to_double(
  * @param[in] n points to the variable to place the converted output in
  * @param[in] endptr is used to keep track of the position in the string
  *
- *  @return This method returns RTEMS_SUCCESSFUL on successful conversion
+ * @retval This method returns RTEMS_SUCCESSFUL on successful conversion
  *         and *n is filled in. Otherwise, the status indicates the
  *         source of the error.
  */