[tracker/rss-enclosures] libtracker-client: Minor documentation fixes

[Roberto Guido <rguido src gnome org>]

commit ec699aa2e2b1c2e68d3575fceea29bcea8718587
Author: Martyn Russell <martyn lanedo com>
Date:   Tue Jun 22 11:14:10 2010 +0100

    libtracker-client: Minor documentation fixes

 src/libtracker-client/tracker.c |   12 ++++++++++--
 1 files changed, 10 insertions(+), 2 deletions(-)
---
diff --git a/src/libtracker-client/tracker.c b/src/libtracker-client/tracker.c
index 8e9f4fa..d8bdd3a 100644
--- a/src/libtracker-client/tracker.c
+++ b/src/libtracker-client/tracker.c
@@ -1903,7 +1903,7 @@ tracker_result_iterator_n_columns (TrackerResultIterator *iterator)
  *
  * Checks if the iterator has more rows
  *
- * Returns: TRUE if there are more rows to fetch, FALSE else
+ * Returns: %TRUE if there are more rows to fetch, otherwise %FALSE.
  *
  * Since: 0.9
  **/
@@ -1927,7 +1927,7 @@ tracker_result_iterator_has_next (TrackerResultIterator *iterator)
  * tracker_result_iterator_next:
  * @iterator: A TrackerResultIterator
  *
- * Fetches the next results row.
+ * Fetches the next row for the results.
  *
  * Since: 0.9
  **/
@@ -1943,6 +1943,13 @@ tracker_result_iterator_next (TrackerResultIterator *iterator)
 		return;
 	}
 
+	/* So, the make up on each iterator segment is:
+	 *
+	 * iteration = [4 bytes for number of columns,
+	 *              4 bytes for last offset]
+	 */
+
+
 	iterator->n_columns = iterator_buffer_read_int (iterator);
 	iterator->offsets = (int *)(iterator->buffer + iterator->buffer_index);
 	iterator->buffer_index += sizeof (int) * (iterator->n_columns - 1);
@@ -1964,6 +1971,7 @@ tracker_result_iterator_next (TrackerResultIterator *iterator)
 /**
  * tracker_result_iterator_value:
  * @iterator: A TrackerResultIterator
+ * @column: the column with the data
  *
  * Get a column's value as a string
  *