Browse Source

Update header/documentation for hasAnotherRow

Rob Ryan 12 years ago
parent
commit
4ac1fc114d
1 changed files with 8 additions and 2 deletions
  1. 8 2
      src/FMResultSet.h

+ 8 - 2
src/FMResultSet.h

@@ -77,13 +77,19 @@
  You must always invoke `next` before attempting to access the values returned in a query, even if you're only expecting one.
 
  @return `YES` if row successfully retrieved; `NO` if end of result set reached
+ 
+ @see hasAnotherRow
  */
 
 - (BOOL)next;
 
-/** Does the result set have another row?
+/** Did the last call to `<next>` succeed in retrieving another row?
 
- @return `YES` if there is another row; `NO` if not.
+ @return `YES` if the last call to `<next>` succeeded in retrieving another record; `NO` if not.
+ 
+ @see next
+ 
+ @warning The `hasAnotherRow` method must follow a call to `<next>`. If the previous database interaction was something other than a call to `next`, then this method may return `NO`, whether there is another row of data or not.
  */
 
 - (BOOL)hasAnotherRow;