[Tinyos-contrib-commits] CVS: tinyos-1.x/contrib/rincon/apps/Blackbook3/interfaces BBoot.nc, 1.1, 1.2 BClean.nc, 1.1, 1.2 BDictionary.nc, 1.1, 1.2

[dmm]

Update of /cvsroot/tinyos/tinyos-1.x/contrib/rincon/apps/Blackbook3/interfaces
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31322/contrib/rincon/apps/Blackbook3/interfaces

Modified Files:
	BBoot.nc BClean.nc BDictionary.nc 
Log Message:
Updated a few interface comments

Index: BBoot.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-1.x/contrib/rincon/apps/Blackbook3/interfaces/BBoot.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** BBoot.nc	20 Apr 2006 23:03:32 -0000	1.1
--- BBoot.nc	21 Apr 2006 23:10:48 -0000	1.2
***************
*** 37,40 ****
--- 37,41 ----
     * The file system finished booting
     * @param totalNodes - the total number of nodes found on flash
+    * @param totalFiles - the total number of files found on flash
     * @param result - SUCCESS if the file system is ready for use.
     */

Index: BClean.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-1.x/contrib/rincon/apps/Blackbook3/interfaces/BClean.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** BClean.nc	20 Apr 2006 23:03:32 -0000	1.1
--- BClean.nc	21 Apr 2006 23:10:48 -0000	1.2
***************
*** 31,45 ****
   
  interface BClean {
    /**
!    * If the free space on the file system is over a threshold
!    * then we should go ahead and defrag and garbage collect.
!    * This should be run when the mote has some time and energy
     * to spare in its application.
!    * @return SUCCESS if the file system will defrag and gc itself
     */
    command result_t performCheckup();
    
    /**  
!    * Run the garbage collector, erasing any sectors that 
     * contain any data with 0 valid nodes.
     * @return SUCCESS if the garbage collector is run
--- 31,46 ----
   
  interface BClean {
+ 
    /**
!    * If the free space on the file system is over a 75% threshold
!    * then we should go ahead and perform a garbage collection.
!    * This should be run periodically when the mote has some time and energy
     * to spare in its application.
!    * @return SUCCESS if the file system will gc itself
     */
    command result_t performCheckup();
    
    /**  
!    * Force the garbage collection, erasing any sectors that 
     * contain any data with 0 valid nodes.
     * @return SUCCESS if the garbage collector is run

Index: BDictionary.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-1.x/contrib/rincon/apps/Blackbook3/interfaces/BDictionary.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** BDictionary.nc	20 Apr 2006 23:03:32 -0000	1.1
--- BDictionary.nc	21 Apr 2006 23:10:48 -0000	1.2
***************
*** 51,55 ****
     * This will invalidate any old key-value pairs using the
     * associated key.
!    * @param key - the key to use
     * @param value - pointer to a buffer containing the value to insert.
     * @param valueSize - the amount of bytes to copy from the buffer
--- 51,55 ----
     * This will invalidate any old key-value pairs using the
     * associated key.
!    * @param key - The key to use.  Any value previously associated with this key will be lost.
     * @param value - pointer to a buffer containing the value to insert.
     * @param valueSize - the amount of bytes to copy from the buffer
***************
*** 101,105 ****
    /** 
     * The opened Dictionary file is now closed
!    * @param result - SUCCSESS if there are no open files
     */
    event void closed(result_t result);
--- 101,105 ----
    /** 
     * The opened Dictionary file is now closed
!    * @param result - SUCCESS if there are no open files
     */
    event void closed(result_t result);
***************
*** 118,122 ****
     * @param key - the key used to find the value
     * @param valueHolder - pointer to the buffer where the value was stored
!    * @param valueSize - the actual size of the value.
     * @param result - SUCCESS if the value was pulled out and is uncorrupted
     */
--- 118,122 ----
     * @param key - the key used to find the value
     * @param valueHolder - pointer to the buffer where the value was stored
!    * @param valueSize - the actual recorded size of the value.
     * @param result - SUCCESS if the value was pulled out and is uncorrupted
     */