CVS update of carob/include (Statement.hpp)

    Date: Wednesday, March 15, 2006 @ 19:52:54
  Author: marc
    Path: /cvsroot/carob/carob/include

Modified: Statement.hpp (1.34 -> 1.35)

Enhanced doxygen of getMoreResults(), moreResult() and getResultSet()


---------------+
 Statement.hpp |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)


Index: carob/include/Statement.hpp
diff -u carob/include/Statement.hpp:1.34 carob/include/Statement.hpp:1.35
--- carob/include/Statement.hpp:1.34    Fri Mar 10 18:06:13 2006
+++ carob/include/Statement.hpp Wed Mar 15 19:52:54 2006
@@ -159,7 +159,7 @@
 
   /**
    * Returns true if there are results available for retrieval with
-   * getMoreResults(), but do NOT get the next result in the list.
+   * getMoreResults(), but does NOT move to the next result in the list.
    * 
    * @return true if there are more results pending for retrieval.
    */
@@ -168,9 +168,9 @@
   /**
    * Return the true if next available result is a ResultSet or false it this 
is
    * an update count. If the result is false and getUpdateCount() returns -1
-   * then there is no more result
+   * then there is no more result.
    * <p>
-   * Any open ResultSet is implicitly closed.
+   * Move to the next result. Any open ResultSet is implicitly closed.
    * 
    * @return true for a ResultSet, false for an updateCount or no more results
    */
@@ -263,7 +263,8 @@
   /**
    * Returns the current result as a <code>DriverResultSet</code> pointer.
    * 
-   * @return pointer to the current result set; null if there are no more
+   * @return pointer to the current result set; null if it is an
+   * update count or there are no more.
    */
   DriverResultSet*        getResultSet() const { return lastResultPtr; }
   /**