[libgdata] core: Clarify that GDataFeed:total-results may be zero for unknown
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgdata] core: Clarify that GDataFeed:total-results may be zero for unknown
- Date: Sun, 3 May 2015 23:48:16 +0000 (UTC)
commit f73d69de95bb934a34b20644de5e84854d046284
Author: Philip Withnall <philip tecnocode co uk>
Date: Sun May 3 23:34:32 2015 +0100
core: Clarify that GDataFeed:total-results may be zero for unknown
The v3 Calendar API doesn’t report the total number of results for
calendar lists, even though it supports pagination. Clarify the
documentation about this.
https://bugzilla.gnome.org/show_bug.cgi?id=664353
gdata/gdata-feed.c | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/gdata/gdata-feed.c b/gdata/gdata-feed.c
index 78a2b4a..cfcbe39 100644
--- a/gdata/gdata-feed.c
+++ b/gdata/gdata-feed.c
@@ -282,7 +282,7 @@ gdata_feed_class_init (GDataFeedClass *klass)
/**
* GDataFeed:total-results:
*
- * The number of items in the result set for the feed, including those on other pages.
+ * The number of items in the result set for the feed, including those on other pages. If this is
zero, the total number is unknown.
*
* This should <emphasis>not</emphasis> be used manually for pagination. Instead, use a #GDataQuery
and call its gdata_query_next_page()
* or gdata_query_previous_page() functions before making the query to the service.
@@ -1060,7 +1060,7 @@ gdata_feed_get_start_index (GDataFeed *self)
* @self: a #GDataFeed
*
* Returns the total number of results in the result set, including results on other
- * pages.
+ * pages. If this is zero, the total number is unknown.
*
* Return value: the total number of results, or <code class="literal">0</code>
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]