[libsoup] soup_form_decode_multipart: document all (out) parameters as nullable



commit 0b7b664ff2c0373bbab9b93346dfb36a76e98320
Author: Simon McVittie <simon mcvittie collabora co uk>
Date:   Wed Feb 8 10:00:58 2012 +0000

    soup_form_decode_multipart: document all (out) parameters as nullable
    
    Signed-off-by: Simon McVittie <simon mcvittie collabora co uk>
    Bug: https://bugzilla.gnome.org/show_bug.cgi?id=669479

 libsoup/soup-form.c |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/libsoup/soup-form.c b/libsoup/soup-form.c
index 6db1dd9..a723430 100644
--- a/libsoup/soup-form.c
+++ b/libsoup/soup-form.c
@@ -116,9 +116,9 @@ soup_form_decode (const char *encoded_form)
  * soup_form_decode_multipart:
  * @msg: a #SoupMessage containing a "multipart/form-data" request body
  * @file_control_name: the name of the HTML file upload control, or %NULL
- * @filename: (out): return location for the name of the uploaded file
- * @content_type: (out): return location for the MIME type of the uploaded file
- * @file: (out): return location for the uploaded file data
+ * @filename: (out) (allow-none): return location for the name of the uploaded file, or %NULL
+ * @content_type: (out) (allow-none): return location for the MIME type of the uploaded file, or %NULL
+ * @file: (out) (allow-none): return location for the uploaded file data, or %NULL
  *
  * Decodes the "multipart/form-data" request in @msg; this is a
  * convenience method for the case when you have a single file upload
@@ -130,7 +130,7 @@ soup_form_decode (const char *encoded_form)
  * control data will be returned (as strings, as with
  * soup_form_decode()) in the returned #GHashTable.
  *
- * You may pass %NULL for @filename and/or @content_type if you do not
+ * You may pass %NULL for @filename, @content_type and/or @file if you do not
  * care about those fields. soup_form_decode_multipart() may also
  * return %NULL in those fields if the client did not provide that
  * information. You must free the returned filename and content-type



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]