Add some directory package doxygen comments

[openafs.git] / src / dir / buffer.c

diff --git a/src/dir/buffer.c b/src/dir/buffer.c
index 9827788..e652acc 100644 (file)
--- a/src/dir/buffer.c
+++ b/src/dir/buffer.c
@@ -97,6 +97,14 @@ DStat(int *abuffers, int *acalls, int *aios)
     return 0;
 }
 
+/**
+ * initialize the directory package.
+ *
+ * @param[in] abuffers  size of directory buffer cache
+ *
+ * @return operation status
+ *    @retval 0 success
+ */
 int
 DInit(int abuffers)
 {
@@ -131,6 +139,15 @@ DInit(int abuffers)
     return 0;
 }
 
+/**
+ * read a page out of a directory object.
+ *
+ * @param[in] fid   directory object fid
+ * @param[in] page  page in hash table to be read
+ *
+ * @return pointer to requested page in directory cache
+ *    @retval NULL read failed
+ */
 void *
 DRead(register afs_int32 *fid, register int page)
 {