[PVFS2-CVS] commit by rbross in pvfs2/src/kernel/linux-2.6: dcache.c dir.c

[CVS commit program]

Update of /projects/cvsroot/pvfs2/src/kernel/linux-2.6
In directory parlweb:/tmp/cvs-serv32178/src/kernel/linux-2.6

Modified Files:
	dcache.c dir.c 
Log Message:
More doxygen.


Index: dcache.c
===================================================================
RCS file: /projects/cvsroot/pvfs2/src/kernel/linux-2.6/dcache.c,v
diff -p -u -r1.21 -r1.22
--- dcache.c	31 Aug 2004 18:09:04 -0000	1.21
+++ dcache.c	11 Jan 2005 17:45:03 -0000	1.22
@@ -4,6 +4,12 @@
  * See COPYING in top-level directory.
  */
 
+/** \file
+ *  \ingroup pvfs2linux
+ *
+ *  Implementation of dentry (directory cache) functions.
+ */
+
 #include "pvfs2-kernel.h"
 
 /* should return 1 if dentry can still be trusted, else 0 */
@@ -31,6 +37,8 @@ int pvfs2_d_revalidate(
 
 #else
 
+/** Verify that dentry is valid.
+ */
 int pvfs2_d_revalidate(
     struct dentry *dentry,
     struct nameidata *nd)
@@ -89,6 +97,7 @@ static int pvfs2_d_compare(
              (memcmp(d_name->name, name->name, d_name->len) == 0));
 }
 
+/** PVFS2 implementation of VFS dentry operations */
 struct dentry_operations pvfs2_dentry_operations =
 {
     .d_revalidate = pvfs2_d_revalidate,

Index: dir.c
===================================================================
RCS file: /projects/cvsroot/pvfs2/src/kernel/linux-2.6/dir.c,v
diff -p -u -r1.31 -r1.32
--- dir.c	28 Oct 2004 21:04:29 -0000	1.31
+++ dir.c	11 Jan 2005 17:45:03 -0000	1.32
@@ -4,6 +4,12 @@
  * See COPYING in top-level directory.
  */
 
+/** \file
+ *  \ingroup pvfs2linux
+ *
+ *  Linux VFS directory operations.
+ */
+
 #include "pvfs2-kernel.h"
 #include "pvfs2-sysint.h"
 
@@ -19,15 +25,17 @@ extern int pvfs2_file_release(
     struct inode *inode,
     struct file *file);
 
-/*
-  should return 0 when we're done traversing a directory;
-  return a negative value on error, or a positive value otherwise.
-  (i.e. if we don't call filldir for ALL entries, return a
-  positive value)
-
-  If the filldir call-back returns non-zero, then readdir should
-  assume that it has had enough, and should return as well.
-*/
+/** Read directory entries from an instance of an open directory.
+ *
+ * \param filldir callback function called for each entry read.
+ *
+ * \retval <0 on error
+ * \retval 0  when directory has been completely traversed
+ * \retval >0 if we don't call filldir for all entries
+ *
+ * \note If the filldir call-back returns non-zero, then readdir should
+ *       assume that it has had enough, and should return as well.
+ */
 static int pvfs2_readdir(
     struct file *file,
     void *dirent,
@@ -265,6 +273,7 @@ static int pvfs2_readdir(
     return ret;
 }
 
+/** PVFS2 implementation of VFS directory operations */
 struct file_operations pvfs2_dir_operations =
 {
 #ifdef PVFS2_LINUX_KERNEL_2_4