diff options
| author | Philip Withnall <philip.withnall@collabora.co.uk> | 2015-04-27 11:08:57 +0100 |
|---|---|---|
| committer | Philip Withnall <philip.withnall@collabora.co.uk> | 2015-04-27 11:12:08 +0100 |
| commit | 62e21438e2f159a36259bc0d6d2e1c661a671c2c (patch) | |
| tree | f307288bba5699ea9625b17dc9280813347fa4b0 | |
| parent | 28d4943a02ec064fb8e83ab8cef3ae7051b982a1 (diff) | |
| download | libsoup-62e21438e2f159a36259bc0d6d2e1c661a671c2c.tar.gz | |
libsoup: Fix a variable name in the documentation
Change the documentation and header file to match the function
definition; this fixes a gtk-doc warning, but introduces no functional
or API changes.
https://bugzilla.gnome.org/show_bug.cgi?id=748514
| -rw-r--r-- | libsoup/soup-websocket.c | 8 | ||||
| -rw-r--r-- | libsoup/soup-websocket.h | 2 |
2 files changed, 4 insertions, 6 deletions
diff --git a/libsoup/soup-websocket.c b/libsoup/soup-websocket.c index 8fe8562c..2c39b1ad 100644 --- a/libsoup/soup-websocket.c +++ b/libsoup/soup-websocket.c @@ -415,16 +415,15 @@ respond_handshake_bad (SoupMessage *msg, const char *why) /** * soup_websocket_server_process_handshake: * @msg: #SoupMessage containing the client side of a WebSocket handshake - * @origin: (allow-none): expected Origin header + * @expected_origin: (allow-none): expected Origin header * @protocols: (allow-none) (array zero-terminated=1): allowed WebSocket * protocols. - * @error: return location for a #GError * * Examines the method and request headers in @msg and (assuming @msg * contains a valid handshake request), fills in the handshake * response. * - * If @origin is non-%NULL, then only requests containing a matching + * If @expected_origin is non-%NULL, then only requests containing a matching * "Origin" header will be accepted. If @protocols is non-%NULL, then * only requests containing a compatible "Sec-WebSocket-Protocols" * header will be accepted. @@ -434,8 +433,7 @@ respond_handshake_bad (SoupMessage *msg, const char *why) * connections, it will call this for you. * * Returns: %TRUE if @msg contained a valid WebSocket handshake - * request and was updated to contain a handshake response. %FALSE - * and an error if not. + * request and was updated to contain a handshake response. %FALSE if not. * * Since: 2.50 */ diff --git a/libsoup/soup-websocket.h b/libsoup/soup-websocket.h index 910b9ae7..20584982 100644 --- a/libsoup/soup-websocket.h +++ b/libsoup/soup-websocket.h @@ -85,7 +85,7 @@ gboolean soup_websocket_server_check_handshake (SoupMessage *msg, SOUP_AVAILABLE_IN_2_50 gboolean soup_websocket_server_process_handshake (SoupMessage *msg, - const char *origin, + const char *expected_origin, char **protocols); G_END_DECLS |