[Simplemail-cvs] simplemail imap.c,1.86,1.87

[Sebastian B. <sb...@us...>]

Update of /cvsroot/simplemail/simplemail
In directory sfp-cvs-1.v30.ch3.sourceforge.com:/tmp/cvs-serv1596

Modified Files:
	imap.c 
Log Message:
Doxygenifized two functions.


Index: imap.c
===================================================================
RCS file: /cvsroot/simplemail/simplemail/imap.c,v
retrieving revision 1.86
retrieving revision 1.87
diff -u -d -r1.86 -r1.87
--- imap.c	24 Dec 2013 09:33:03 -0000	1.86
+++ imap.c	24 Dec 2013 09:33:19 -0000	1.87
@@ -2233,9 +2233,15 @@
 	return success;
 }
 
-/**************************************************************************
- Delete a mail permanently. Thread version.
-**************************************************************************/
+/**
+ * Delete a mail permanently from the server
+ *
+ * @param filename
+ * @param server
+ * @param folder
+ * @return success or not.
+ * @note This function can only be called in the context of the imap thread.
+ */
 static int imap_thread_delete_mail_by_filename(char *filename, struct imap_server *server, struct folder *folder)
 {
 	char send[200];
@@ -2295,9 +2301,17 @@
 	return success;
 }
 
-/**************************************************************************
- Store a mail. Thread version.
-**************************************************************************/
+/**
+ * Store the mail represented by the mail located in the given source_dir
+ * on the given server in the given dest_folder.
+ *
+ * @param mail
+ * @param source_dir
+ * @param server
+ * @param dest_folder
+ * @return success or not.
+ * @note This function can only be called in the context of the imap thread.
+ */
 static int imap_thread_append_mail(struct mail_info *mail, char *source_dir, struct imap_server *server, struct folder *dest_folder)
 {
 	char send[200];