From: Dan Winship <danw@src.gnome.org>
Date: Fri, 16 Jun 2000 01:27:55 +0000 (+0000)
Subject: document camel_folder_search_by_expression
X-Git-Tag: upstream/3.7.4~11684
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4dbffc6c5acc0474abaa945d12702c688e449b96;p=platform%2Fupstream%2Fevolution-data-server.git

document camel_folder_search_by_expression
---

diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 6fda77d..a5ccc24 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -842,9 +842,20 @@ search_by_expression (CamelFolder *folder, const char *expression,
 	return NULL;
 }
 
-GList *camel_folder_search_by_expression (CamelFolder *folder,
-					  const char *expression,
-					  CamelException *ex)
+/**
+ * camel_folder_search_by_expression:
+ * @folder: Folder object
+ * @expression: a search expression
+ * @ex: a CamelException
+ *
+ * Searches the folder for messages matching the given search expression.
+ *
+ * Return value: a list of uids of matching messages. The caller must
+ * free the list and each of the elements when it is done.
+ **/
+GList *
+camel_folder_search_by_expression (CamelFolder *folder, const char *expression,
+				   CamelException *ex)
 {
 	g_return_val_if_fail (CAMEL_IS_FOLDER (folder), NULL);
 	g_return_val_if_fail (folder->has_search_capability, NULL);