libcsupport: Doxygen Enhancement Task #8

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

5 files changed, 33 insertions, 1 deletions

diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 70ac56d662..06a74849ef 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -85,6 +85,9 @@ const char *rtems_assoc_name_by_local(
   uint32_t
 );
 
+/**
+ *  @brief RTEMS Associate Name by Remote
+ */
 const char *rtems_assoc_name_by_remote(
   const rtems_assoc_t *,
   uint32_t
diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h
index abe70205e3..81e2156ba4 100644
--- a/cpukit/libcsupport/include/rtems/libcsupport.h
+++ b/cpukit/libcsupport/include/rtems/libcsupport.h
@@ -56,6 +56,12 @@ Heap_Control *malloc_get_heap_pointer( void );
 extern void libc_init(void);
 extern int  host_errno(void);
 extern void fix_syscall_errno(void);
+
+/**
+ *  @brief RTEMS Malloc Get Free Information
+ * 
+ *  Find amount of free heap remaining
+ */
 extern size_t malloc_free_space(void);
 extern void open_dev_console(void);
 
diff --git a/cpukit/libcsupport/include/rtems/libio.h b/cpukit/libcsupport/include/rtems/libio.h
index 41c6a7072e..84f3dc7451 100644
--- a/cpukit/libcsupport/include/rtems/libio.h
+++ b/cpukit/libcsupport/include/rtems/libio.h
@@ -4,6 +4,10 @@
  * @ingroup LibIO
  *
  * @brief Basic IO API.
+ * 
+ * This file contains the support infrastructure used to manage the
+ * table of integer style file descriptors used by the low level
+ * POSIX system calls like open(), read, fstat(), etc.
  */
 
 /*
@@ -1251,6 +1255,11 @@ typedef struct {
 
 /** @} */
 
+/**
+ * @brief RTEMS LibIO Initialization
+ * 
+ * Called by BSP startup code to initialize the libio subsystem.
+ */
 void rtems_libio_init(void);
 
 /**
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index 8e5fa41597..6ef4b6ccb6 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -276,12 +276,26 @@ static inline void rtems_filesystem_instance_unlock(
  *  File Descriptor Routine Prototypes
  */
 
+/**
+ *  This routine searches the IOP Table for an unused entry.  If it
+ *  finds one, it returns it.  Otherwise, it returns NULL.
+ */
 rtems_libio_t *rtems_libio_allocate(void);
 
+/**
+ *  Convert UNIX fnctl(2) flags to ones that RTEMS drivers understand
+ */
 uint32_t rtems_libio_fcntl_flags( int fcntl_flags );
 
+/**
+ *  Convert RTEMS internal flags to UNIX fnctl(2) flags
+ */
 int rtems_libio_to_fcntl_flags( uint32_t flags );
 
+/**
+ *  This routine frees the resources associated with an IOP (file descriptor)
+ *  and clears the slot in the IOP Table.
+ */
 void rtems_libio_free(
   rtems_libio_t *iop
 );
diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h
index a257674a38..c428bcffb2 100644
--- a/cpukit/libcsupport/include/rtems/malloc.h
+++ b/cpukit/libcsupport/include/rtems/malloc.h
@@ -110,7 +110,7 @@ typedef void (*rtems_malloc_dirtier_t)(void *, size_t);
 extern rtems_malloc_dirtier_t rtems_malloc_dirty_helper;
 
 /**
- *  @brief Dirty memory function
+ *  @brief Dirty Memory Function
  *
  *  This method fills the specified area with a non-zero pattern
  *  to aid in debugging programs which do not initialize their