libfs: Doxygen Enhancement Task #1

1 files changed, 7 insertions, 17 deletions

diff --git a/cpukit/libfs/src/imfs/imfs_directory.c b/cpukit/libfs/src/imfs/imfs_directory.c
index 99d990d24f..c344af4cd7 100644
--- a/cpukit/libfs/src/imfs/imfs_directory.c
+++ b/cpukit/libfs/src/imfs/imfs_directory.c
@@ -1,6 +1,11 @@
-/*
- *  IMFS Directory Access Routines
+/**
+ * @file
  *
+ * @brief IMFS Read Next Directory
+ * @ingroup IMFS
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -18,21 +23,6 @@
 #include <string.h>
 #include <dirent.h>
 
-/*
- *  imfs_dir_read
- *
- *  This routine will read the next directory entry based on the directory
- *  offset. The offset should be equal to -n- time the size of an individual
- *  dirent structure. If n is not an integer multiple of the sizeof a
- *  dirent structure, an integer division will be performed to determine
- *  directory entry that will be returned in the buffer. Count should reflect
- *  -m- times the sizeof dirent bytes to be placed in the buffer.
- *  If there are not -m- dirent elements from the current directory position
- *  to the end of the exisiting file, the remaining entries will be placed in
- *  the buffer and the returned value will be equal to -m actual- times the
- *  size of a directory entry.
- */
-
 ssize_t imfs_dir_read(
   rtems_libio_t  *iop,
   void           *buffer,