libcsupport: Doxygen enhancement task #9

4 files changed, 48 insertions, 39 deletions

diff --git a/cpukit/libcsupport/include/rtems/gxx_wrappers.h b/cpukit/libcsupport/include/rtems/gxx_wrappers.h
index 2ef180a629..33b163043f 100644
--- a/cpukit/libcsupport/include/rtems/gxx_wrappers.h
+++ b/cpukit/libcsupport/include/rtems/gxx_wrappers.h
@@ -25,6 +25,14 @@
 extern "C" {
 #endif /* __cplusplus */
 
+/**
+ *  @defgroup GxxWrappersSupport Gxx Wrappers Support
+ *
+ *  @ingroup libcsupport
+ *
+ *  @brief RTEMS Threads Compatibility Routines for Libgcc2
+ */
+
 /*
  * These typedefs should match with the ones defined in the file
  * gcc/gthr-rtems.h in the gcc distribution.
diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h
index 5b7895d591..85bcb9774d 100644
--- a/cpukit/libcsupport/include/rtems/libio.h
+++ b/cpukit/libcsupport/include/rtems/libio.h
@@ -1176,9 +1176,9 @@ typedef struct {
 } rtems_filesystem_limits_and_options_t;
 
 /**
- * @brief Default pathconf settings.
+ *  @brief Default Pathconf Settings
  *
- * Override in a filesystem.
+ *  Override in a filesystem.
  */
 extern const rtems_filesystem_limits_and_options_t
   rtems_filesystem_default_pathconf;
@@ -1551,37 +1551,38 @@ int unmount(
 );
 
 /**
- * @brief Mounts a file system at @a target.
- *
- * The @a source may be a path to the corresponding device file, or @c NULL.
- * The @a target path must lead to an existing directory, or @c NULL.  In case
- * @a target is @c NULL, the root file system will be mounted.  The @a data
- * parameter will be forwarded to the file system initialization handler.  The
- * file system type is selected by @a filesystemtype and may be one of
- * - RTEMS_FILESYSTEM_TYPE_DEVFS,
- * - RTEMS_FILESYSTEM_TYPE_DOSFS,
- * - RTEMS_FILESYSTEM_TYPE_FTPFS,
- * - RTEMS_FILESYSTEM_TYPE_IMFS,
- * - RTEMS_FILESYSTEM_TYPE_MINIIMFS,
- * - RTEMS_FILESYSTEM_TYPE_NFS,
- * - RTEMS_FILESYSTEM_TYPE_RFS, or
- * - RTEMS_FILESYSTEM_TYPE_TFTPFS.
- *
- * Only configured or registered file system types are available.  You can add
- * file system types to your application configuration with
- * - CONFIGURE_FILESYSTEM_DEVFS,
- * - CONFIGURE_FILESYSTEM_DOSFS,
- * - CONFIGURE_FILESYSTEM_FTPFS,
- * - CONFIGURE_FILESYSTEM_IMFS,
- * - CONFIGURE_FILESYSTEM_MINIIMFS,
- * - CONFIGURE_FILESYSTEM_NFS,
- * - CONFIGURE_FILESYSTEM_RFS, and
- * - CONFIGURE_FILESYSTEM_TFTPFS.
- *
- * @see rtems_filesystem_register() and mount_and_make_target_path().
- *
- * @retval 0 Successful operation.
- * @retval -1 An error occured.  The @c errno indicates the error.
+ *  @brief Mounts a File System
+ *
+ *  The @a source may be a path to the corresponding device file, or @c NULL.
+ *  The @a target path must lead to an existing directory, or @c NULL.  
+ *  In case @a target is @c NULL, the root file system will be mounted.  
+ *  The @a data parameter will be forwarded to the file system
+ *  initialization handler.  The file system type is selected by
+ *  @a filesystemtype and may be one of
+ *  - RTEMS_FILESYSTEM_TYPE_DEVFS,
+ *  - RTEMS_FILESYSTEM_TYPE_DOSFS,
+ *  - RTEMS_FILESYSTEM_TYPE_FTPFS,
+ *  - RTEMS_FILESYSTEM_TYPE_IMFS,
+ *  - RTEMS_FILESYSTEM_TYPE_MINIIMFS,
+ *  - RTEMS_FILESYSTEM_TYPE_NFS,
+ *  - RTEMS_FILESYSTEM_TYPE_RFS, or
+ *  - RTEMS_FILESYSTEM_TYPE_TFTPFS.
+ *
+ *  Only configured or registered file system types are available.  
+ *  You can add file system types to your application configuration with
+ *  - CONFIGURE_FILESYSTEM_DEVFS,
+ *  - CONFIGURE_FILESYSTEM_DOSFS,
+ *  - CONFIGURE_FILESYSTEM_FTPFS,
+ *  - CONFIGURE_FILESYSTEM_IMFS,
+ *  - CONFIGURE_FILESYSTEM_MINIIMFS,
+ *  - CONFIGURE_FILESYSTEM_NFS,
+ *  - CONFIGURE_FILESYSTEM_RFS, and
+ *  - CONFIGURE_FILESYSTEM_TFTPFS.
+ *
+ *  @see rtems_filesystem_register() and mount_and_make_target_path().
+ *
+ *  @retval 0 Successful operation.
+ *  @retval -1 An error occured.  The @c errno indicates the error.
  */
 int mount(
   const char                 *source,
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index f56926acd9..7c5a29f0c3 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -179,14 +179,14 @@ extern rtems_filesystem_global_location_t rtems_filesystem_global_location_null;
    rtems_libio_check_permissions_with_error(_iop, _flag, EINVAL )
 
 /**
- * @brief Clones a node.
+ *  @brief Clones a Node
  *
- * The caller must hold the file system instance lock.
+ *  The caller must hold the file system instance lock.
  *
- * @param[out] clone The cloned location.
- * @param[in] master The master location.
+ *  @param[out] clone The cloned location.
+ *  @param[in] master The master location.
  *
- * @see rtems_filesystem_instance_lock().
+ *  @see rtems_filesystem_instance_lock().
  */
 void rtems_filesystem_location_clone(
   rtems_filesystem_location_info_t *clone,
diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h
index 877bdbc0e4..a257674a38 100644
--- a/cpukit/libcsupport/include/rtems/malloc.h
+++ b/cpukit/libcsupport/include/rtems/malloc.h
@@ -157,7 +157,7 @@ void malloc_report_statistics_with_plugin(
 );
 
 /**
- *  @brief RTEMS variation on Aligned Memory Allocation
+ *  @brief RTEMS Variation on Aligned Memory Allocation
  *
  *  This method is a help memalign implementation which does all
  *  error checking done by posix_memalign() EXCEPT it does NOT