[libsoup] soup_message_get_https_status(): Improved documentation



commit 33fc6688dbc45f0052dac5e0d826882cf36cf22f
Author: Tristan Van Berkom <tristan upstairslabs com>
Date:   Tue Oct 14 20:41:39 2014 +0900

    soup_message_get_https_status(): Improved documentation
    
    Added a note that this API is only meaningful in the context
    of a SoupSession (i.e. it's not meaningful for a SoupServer).

 libsoup/soup-message.c |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)
---
diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index 23fd8b0..dd1917c 100644
--- a/libsoup/soup-message.c
+++ b/libsoup/soup-message.c
@@ -1914,6 +1914,9 @@ soup_message_set_https_status (SoupMessage *msg, SoupConnection *conn)
  * showing what problems, if any, have been found with that
  * certificate.
  *
+ * <note><para>This is only meaningful with messages processed by a #SoupSession and is
+ * not useful for messages received by a #SoupServer</para></note>
+ *
  * Return value: %TRUE if @msg used/attempted https, %FALSE if not
  *
  * Since: 2.34


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