summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan@upstairslabs.com>2014-10-14 20:41:39 +0900
committerTristan Van Berkom <tristan@upstairslabs.com>2014-10-14 20:47:57 +0900
commit33fc6688dbc45f0052dac5e0d826882cf36cf22f (patch)
tree9e9f3217e9993b5d6832371a4900e881e753c634
parentd0c09bfdce47d0d79bbedbd49e88395e3278765c (diff)
downloadlibsoup-33fc6688dbc45f0052dac5e0d826882cf36cf22f.tar.gz
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).
-rw-r--r--libsoup/soup-message.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index 23fd8b08..dd1917c2 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