libfs: Doxygen Enhancement Task #2

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

8 files changed, 67 insertions, 71 deletions

diff --git a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.c b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.c
index 85837b0009..c14c69d1fe 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-bitmaps.c
@@ -1,23 +1,23 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  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.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Bitmap Routines
  * @ingroup rtems-rfs
- *
- * RTEMS File Systems Bitmap Routines.
- *
+ * 
  * These functions manage bit maps. A bit map consists of the map of bit
  * allocated in a block and a search map where a bit represents 32 actual
  * bits. The search map allows for a faster search for an available bit as 32
  * search bits can checked in a test.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  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.
+ */
+
 #if HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-block.c b/cpukit/libfs/src/rfs/rtems-rfs-block.c
index 7ebc4d76a6..4ad73b2ee3 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-block.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-block.c
@@ -1,21 +1,13 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  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.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Block Routines
  * @ingroup rtems-rfs
- *
- * RTEMS File Systems Block Routines.
- *
+ * 
  * These functions manage blocks in the RFS file system. A block is an area of
  * the media and its size is set for a each specific media. The block size is
- * set when the file system is set up and needs to be matched for it to be read
- * correctly.
+ * set when the file system is set up and needs to be matched for it to be 
+ * read correctly.
  *
  * Blocks are managed as groups. A block group or "group" is part of the total
  * number of blocks being managed by the file system and exist to allow
@@ -26,12 +18,20 @@
  * A group consist of a block bitmap, inodes and data blocks. The first block
  * of the file system will hold the superblock. The block bitmap is a
  * collection of blocks that hold a map of bits, one bit per block for each
- * block in the group. When a file system is mounted the block bitmaps are read
- * and a summary bit map is made. The summary bitmap has a single bit for 32
- * bits in the bitmap and is set when all 32 bits it maps to are set. This
+ * block in the group. When a file system is mounted the block bitmaps are 
+ * read and a summary bit map is made. The summary bitmap has a single bit for
+ * 32 bits in the bitmap and is set when all 32 bits it maps to are set. This
  * speeds up the search for a free block by a factor of 32.
  */
 
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  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.
+ */
+
 #if HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.c b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.c
index 951bce1a0a..db8f21a8b0 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.c
@@ -1,9 +1,8 @@
 /**
  * @file
  *
+ * @brief RTEMS File Systems Directory Hash function
  * @ingroup rtems-rfs
- *
- * RTEMS File Systems Directory Hash function.
  */
 
 #if HAVE_CONFIG_H
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-inode.c b/cpukit/libfs/src/rfs/rtems-rfs-inode.c
index 6c49b2ac7a..51129e9378 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-inode.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-inode.c
@@ -1,20 +1,19 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  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.
- */
 /**
  * @file
  *
+ * @brief RTEMS File Systems Inode Routines
  * @ingroup rtems-rfs
- *
- * RTEMS File Systems Inode Routines.
- *
+ * 
  * These functions manage inodes in the RFS file system. An inode is part of a
  * block that reside after the bitmaps in the group.
  */
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
+ *
+ *  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.
+ */
 
 #if HAVE_CONFIG_H
 #include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-link.c b/cpukit/libfs/src/rfs/rtems-rfs-link.c
index 7211e3ad59..225a37fac9 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-link.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-link.c
@@ -1,3 +1,13 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Systems Link Routines
+ * @ingroup rtems-rfs
+ * 
+ * These functions manage links. A link is the addition of a directory entry
+ * in a parent directory and incrementing the links count in the inode.
+ */
+
 /*
  *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
  *
@@ -5,16 +15,6 @@
  *  found in the file LICENSE in this distribution or at
  *  http://www.rtems.com/license/LICENSE.
  */
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File Systems Link Routines.
- *
- * These functions manage links. A link is the addition of a directory entry in
- * a parent directory and incrementing the links count in the inode.
- */
 
 #if HAVE_CONFIG_H
 #include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-mutex.c b/cpukit/libfs/src/rfs/rtems-rfs-mutex.c
index 4fd6f384fe..7bf92f7cd5 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-mutex.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-mutex.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File System Mutex
+ * @ingroup rtems-rfs
+ */
 /*
  *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
  *
@@ -5,13 +11,6 @@
  *  found in the file LICENSE in this distribution or at
  *  http://www.rtems.com/license/LICENSE.
  */
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File System Mutex.
- */
 
 #if HAVE_CONFIG_H
 #include "config.h"
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-rtems-dev.c b/cpukit/libfs/src/rfs/rtems-rfs-rtems-dev.c
index ced234a796..97d0104cdd 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-rtems-dev.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-rtems-dev.c
@@ -1,20 +1,19 @@
-/*
- *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
- *
- *  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.
- */
 /**
  * @file
  *
+ * @brief RTEMS RFS Device Interface
  * @ingroup rtems-rfs
- *
- * RTEMS RFS Device Interface.
- *
+ * 
  * This file contains the set of handlers used to map operations on RFS device
  * nodes onto calls to the RTEMS Classic API IO Manager.
+ */
+
+/*
+ *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
  *
+ *  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.
  */
 
 #if HAVE_CONFIG_H
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-rtems.c b/cpukit/libfs/src/rfs/rtems-rfs-rtems.c
index 6ff9793911..d2aac56429 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-rtems.c
+++ b/cpukit/libfs/src/rfs/rtems-rfs-rtems.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File System Interface for RTEMS
+ * @ingroup rtems-rfs
+ */
+
 /*
  *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
  *
@@ -8,13 +15,6 @@
  *  found in the file LICENSE in this distribution or at
  *  http://www.rtems.com/license/LICENSE.
  */
-/**
- * @file
- *
- * @ingroup rtems-rfs
- *
- * RTEMS File System Interface for RTEMS.
- */
 
 #if HAVE_CONFIG_H
 #include "config.h"