[evolution-data-server: 13/13] Add some doc to the API.
- From: Srinivasa Ragavan <sragavan src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server: 13/13] Add some doc to the API.
- Date: Thu, 2 Feb 2012 11:04:13 +0000 (UTC)
commit 3a8ed437a3547803f1453f73dbf22911b8ae0051
Author: Srinivasa Ragavan <sragavan gnome org>
Date: Thu Feb 2 16:30:00 2012 +0530
Add some doc to the API.
camel/camel-folder.c | 6 +++++-
1 files changed, 5 insertions(+), 1 deletions(-)
---
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 7eaf143..e14a6a1 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -3447,7 +3447,11 @@ camel_folder_fetch_messages_sync (CamelFolder *folder,
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
- * Asynchronously download new or old messages from the server.
+ * Asynchronously download new or old messages from the server. It is assumes that the client has only a
+ * window of interested messages of what server has. And old/new type helps to expand that window.
+ *
+ * type = CAMEL_FETCH_OLD_MESSAGES: Downloads messages older than what the client already has.
+ * type = CAMEL_FETCH_NEW_MESSAGES: Downloads messages newer than what the client already has.
*
* When the operation is finished, @callback will be called. You can then
* call camel_folder_fetch_messages_finish() to get the result of the operation.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]