[libpst-commits] r87 - trunk

[Chris Halls]

Author: halls
Date: 2007-01-29 20:22:55 +0100 (Mon, 29 Jan 2007)
New Revision: 87

Modified:
   trunk/libpst.c
Log:
Add Doxygen style comments for _pst_ff_getIDblock and _pst_ff_getIDblock_dec


Index: trunk/libpst.c
===================================================================
--- trunk/libpst.c	(revision 86)
+++ trunk/libpst.c	(revision 87)
@@ -4080,6 +4080,13 @@
   return 0;
 }
 
+/**
+ * Get an ID block from file using _pst_ff_getIDblock and decrypt if necessary
+ * @param pf PST file structure
+ * @param id ID of block to retrieve
+ * @param b  Reference to pointer that will be set to new block. Any memory pointed to by buffer will be free()d beforehand
+ * @return   Size of block pointed to by *b
+ */
 size_t _pst_ff_getIDblock_dec(pst_file *pf, u_int32_t id, unsigned char **b) {
   size_t r;
   DEBUG_ENT("_pst_ff_getIDblock_dec");
@@ -4090,8 +4097,13 @@
   return r;
 }
 
-/** the get ID function for the default file format that I am working with
-    ie the one in the PST files */
+/**
+ * Read a block of data from file into memory
+ * @param pf PST file
+ * @param id identifier of block to read
+ * @param b  reference to pointer to buffer. If this pointer is non-NULL, it will first be free()d
+ * @return   size of block read into memory
+ */
 size_t _pst_ff_getIDblock(pst_file *pf, u_int32_t id, unsigned char** b) {
   pst_index_ll *rec;
   size_t rsize = 0;//, re_size=0;