[cvs] Expresso commit by lhamel: more javadoc

[JCorporate Ltd]

Log Message:
-----------
more javadoc

Modified Files:
--------------
    expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/dbobj:
        DBObject.java

Revision Data
-------------
Index: DBObject.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/dbobj/DBObject.java,v
retrieving revision 1.210
retrieving revision 1.211
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/dbobj/DBObject.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/dbobj/DBObject.java -u -r1.210 -r1.211
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/dbobj/DBObject.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/dbobj/DBObject.java
@@ -2018,6 +2018,7 @@
      * you use a blank DBObject, then all the records in the table will be
      * deleted
      *
+     * @param oneByOne set 'true' usually, to make sure that all 'detail' records are also deleted.  Set to false if you are sure that the table has no detail records (i.e., it supplies no foreign keys--has no dependent records)
      * @throws DBException upon error
      */
     public synchronized void deleteAll(boolean oneByOne)
@@ -2032,11 +2033,11 @@
 
     /**
      * Delete all records inside the database.
+     * Important:  this method ignores any 'detail' records.  Use this only if you are sure that the table has no detail records (i.e., it supplies no foreign keys--has no dependent records)
      *
      * @param deleteAllRecords Delete associated detail records if true
-     * @throws DBException Modify by Yves Henri AMAIZO <amy_amaizo at compuserve.com>
+     * @throws DBException Modify
      * @see DBObject#deleteAll to delete objects identified by non-key fields
-     * @since $DatabaseSchema  $Date$
      */
     public synchronized void doDeleteAll(boolean deleteAllRecords)
             throws DBException {