libcsupport: GCI Doxygen Task #7

http://www.google-melange.com/gci/task/view/google/gci2012/7975223

5 files changed, 37 insertions, 7 deletions

diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 48234c9fb4..9264560870 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -101,6 +101,9 @@ char *rtems_assoc_name_by_local_bitfield(
   char *
 );
 
+/**
+ *  @brief RTEMS Associate Name by Remote Bitfield
+ */
 char *rtems_assoc_name_by_remote_bitfield(
   const rtems_assoc_t *,
   uint32_t  ,
diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h
index 600ee84562..abe70205e3 100644
--- a/cpukit/libcsupport/include/rtems/libcsupport.h
+++ b/cpukit/libcsupport/include/rtems/libcsupport.h
@@ -39,6 +39,12 @@ extern void malloc_dump(void);
  *  @brief Malloc Walk
  */
 extern bool malloc_walk(int source, bool printf_enabled);
+
+/**
+ *  @brief RTEMS Malloc Set Heap Pointer
+ * 
+ *  This routine is primarily used for debugging. 
+ */
 void malloc_set_heap_pointer(Heap_Control *new_heap);
 
 /**
diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h
index 9374f3ac1a..5b7895d591 100644
--- a/cpukit/libcsupport/include/rtems/libio.h
+++ b/cpukit/libcsupport/include/rtems/libio.h
@@ -1373,6 +1373,14 @@ static inline rtems_device_minor_number rtems_filesystem_dev_minor_t(
  *  Prototypes for filesystem
  */
 
+/**
+ *  @brief Base File System Initialization
+ *  
+ *  Initialize the foundation of the file system.  This is specified
+ *  by the structure rtems_filesystem_mount_table.  The usual
+ *  configuration is a single instantiation of the IMFS or miniIMFS with
+ *  a single "/dev" directory in it.
+ */
 void rtems_filesystem_initialize( void );
 
 typedef void (*rtems_libio_init_functions_t)(void);
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index 2ab40eef2a..d6d7ddfca7 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -30,11 +30,11 @@ extern "C" {
 #endif
 
 /**
- * @defgroup LibIOInternal IO Internal Library
+ *  @defgroup LibIOInternal IO Internal Library
  *
- * @brief Internal IO library API and implementation.
+ *  @brief Internal IO library API and implementation.
  *
- * @{
+ *  @{
  */
 
 #define RTEMS_FILESYSTEM_SYMLOOP_MAX 32
@@ -62,7 +62,7 @@ extern const rtems_filesystem_file_handlers_r rtems_filesystem_null_handlers;
 extern rtems_filesystem_mount_table_entry_t rtems_filesystem_null_mt_entry;
 
 /**
- * @brief The global null location.
+ *  @brief The Global NULL Location
  *
  * Every operation and the open and fstat handlers of this location returns an
  * error status.  The errno is not touched by these operations and handlers.
@@ -770,10 +770,10 @@ void rtems_filesystem_eval_path_error(
 );
 
 /**
- * @brief Checks that the locations exist in the same file system instance.
+ *  @brief Checks that the Locations Exist in the Same File System Instance
  *
- * @retval 0 The locations exist and are in the same file system instance.
- * @retval -1 An error occured.  The @c errno indicates the error.
+ *  @retval 0 The locations exist and are in the same file system instance.
+ *  @retval -1 An error occured.  The @c errno indicates the error.
  */
 int rtems_filesystem_location_exists_in_same_instance_as(
   const rtems_filesystem_location_info_t *a,
diff --git a/cpukit/libcsupport/include/sys/termios.h b/cpukit/libcsupport/include/sys/termios.h
index dc4f9a1faf..b65f81dc08 100644
--- a/cpukit/libcsupport/include/sys/termios.h
+++ b/cpukit/libcsupport/include/sys/termios.h
@@ -191,6 +191,11 @@ struct termios {
 #define	TCSAFLUSH	2
 
 int	tcdrain(int);
+
+/**
+ *  @brief Line Control Functions
+ *  POSIX 1003.1b 7.2.2 - Line Control Functions
+ */
 int	tcflow(int, int);
 int	tcflush(int, int);
 int	tcgetattr(int, struct termios *);
@@ -204,8 +209,16 @@ int	tcsendbreak(int, int);
  *  @brief Baud Rate Functions
  */
 speed_t	cfgetospeed(const struct termios *tp);
+
+/**
+ *  @brief Baud Rate Functions
+ */
 int	cfsetospeed(struct termios *tp, speed_t speed);
 speed_t	cfgetispeed(const struct termios *tp);
+
+/**
+ *  @brief Baud Rate Functions
+ */
 int	cfsetispeed(struct termios *tp, speed_t speed);
 
 #ifdef __cplusplus