[evolution/webkit: 42/171] Add documentation to em_format_build_mail_uri.

[Dan VrÃtil <dvratil src gnome org>]

commit 117968f9bd3dbdcb400488d0679d8d36312e6346
Author: Dan VrÃtil <dvratil redhat com>
Date:   Fri Oct 14 11:14:31 2011 +0200

    Add documentation to em_format_build_mail_uri.
    
    I still keep forgetting how the query parameters should look like...

 em-format/em-format.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/em-format/em-format.c b/em-format/em-format.c
index 7cbc53e..a5538a3 100644
--- a/em-format/em-format.c
+++ b/em-format/em-format.c
@@ -2218,6 +2218,16 @@ em_format_snoop_type (CamelMimePart *part)
 	   see bug #211778 for some discussion */
 }
 
+/**
+ * Construct a URI for message.
+ * 
+ * The URI can contain multiple query parameters. The list of parameters must be
+ * NULL-terminated. Each query must contain name, GType of value and value.
+ * 
+ * @param folder Folder wit the message
+ * @param message_uid ID of message within the \p folder
+ * @param first_param_name Name of first query parameter followed by GType of it's value and value.
+ */
 gchar*
 em_format_build_mail_uri (CamelFolder *folder,
 			  const gchar *message_uid,