Fixed all gtk-doc moans in soup-core documentation

2001-05-17  Dick Porter  <dick@ximian.com>

	* Fixed all gtk-doc moans in soup-core documentation

diff --git a/ChangeLog b/ChangeLog
index 5271893..4d35074 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2001-05-17  Dick Porter  <dick@ximian.com>
 
+       * Fixed all gtk-doc moans in soup-core documentation
+
        * docs/reference: Extract gtk-doc documentation from the code
 
        * tests/test-wsdl-runtime.c: 

diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index 7d90b74..3f66d74 100644 (file)
--- a/libsoup/soup-message.c
+++ b/libsoup/soup-message.c
@@ -118,7 +118,7 @@ soup_message_remove_header (gchar *name, gchar *value, gpointer unused)
  * soup_message_free:
  * @req: a %SoupMessage to destroy.
  * 
- * Destroys the %SoupMessage pointed to by %req. Request and response headers
+ * Destroys the %SoupMessage pointed to by @req. Request and response headers
  * are freed. Request and response data buffers are also freed if their
  * ownership is %SOUP_BUFFER_SYSTEM_OWNED. The message's destination context
  * will be de-referenced.
@@ -246,7 +246,6 @@ soup_message_set_request_header (SoupMessage *req,
  * soup_message_get_request_header:
  * @req: a %SoupMessage.
  * @name: header name.
- * @value: header value.
  * 
  * Lookup the transport request header with a key equal to @name.
  *
@@ -286,7 +285,6 @@ soup_message_set_response_header (SoupMessage *req,
  * soup_message_get_response_header:
  * @req: a %SoupMessage.
  * @name: header name.
- * @value: header value.
  * 
  * Lookup the transport response header with a key equal to @name.
  *
@@ -305,7 +303,7 @@ soup_message_get_response_header (SoupMessage *req,
 
 /**
  * soup_message_send:
- * @req: a %SoupMessage.
+ * @msg: a %SoupMessage.
  * 
  * Syncronously send @msg. This call will not return until the transfer is
  * finished successfully or there is an unrecoverable error. 

diff --git a/libsoup/soup-message.h b/libsoup/soup-message.h
index 91772ce..6ce3cc4 100644 (file)
--- a/libsoup/soup-message.h
+++ b/libsoup/soup-message.h
@@ -81,13 +81,13 @@ SoupMessage   *soup_message_new_full           (SoupContext       *context,
                                                gchar             *req_body,
                                                gulong             req_length);
 
-void           soup_message_free               (SoupMessage       *msg);
+void           soup_message_free               (SoupMessage       *req);
 
-void           soup_message_cancel             (SoupMessage       *msg);
+void           soup_message_cancel             (SoupMessage       *req);
 
 SoupErrorCode  soup_message_send               (SoupMessage       *msg);
 
-void           soup_message_queue              (SoupMessage       *msg, 
+void           soup_message_queue              (SoupMessage       *req, 
                                                SoupCallbackFn     callback, 
                                                gpointer           user_data);
 

diff --git a/libsoup/soup-misc.c b/libsoup/soup-misc.c
index b685ca5..335f907 100644 (file)
--- a/libsoup/soup-misc.c
+++ b/libsoup/soup-misc.c
@@ -98,8 +98,7 @@ soup_set_security_policy (SoupSecurityPolicy policy)
 }
 
 /**
- * soup_set_security_policy:
- * @policy: the %SoupSecurityPolicy to use.
+ * soup_get_security_policy:
  * 
  * Return value: The security policy to use for secure SSL connections.
  */

diff --git a/libsoup/soup-misc.h b/libsoup/soup-misc.h
index e584d24..77fc664 100644 (file)
--- a/libsoup/soup-misc.h
+++ b/libsoup/soup-misc.h
@@ -21,7 +21,7 @@ void               soup_load_config          (gchar       *config_file);
 
 void               soup_shutdown             (void);
 
-void               soup_set_proxy            (SoupContext *ctx);
+void               soup_set_proxy            (SoupContext *context);
 
 SoupContext       *soup_get_proxy            (void);
 

diff --git a/libsoup/soup-socket.h b/libsoup/soup-socket.h
index 446adc6..da99f2d 100644 (file)
--- a/libsoup/soup-socket.h
+++ b/libsoup/soup-socket.h
@@ -94,7 +94,7 @@ typedef void (*SoupSocketConnectFn) (SoupSocket              *socket,
 SoupSocketConnectId  soup_socket_connect        (const gchar*        hostname,
                                                 const gint          port, 
                                                 SoupSocketConnectFn func, 
-                                                gpointer            user_data);
+                                                gpointer            data);
 
 void                 soup_socket_connect_cancel (SoupSocketConnectId id);
 
@@ -116,7 +116,7 @@ typedef void (*SoupSocketNewFn) (SoupSocket*         socket,
 
 SoupSocketNewId     soup_socket_new             (SoupAddress        *addr, 
                                                 SoupSocketNewFn     func,
-                                                gpointer            user_data);
+                                                gpointer            data);
 
 void                soup_socket_new_cancel      (SoupSocketNewId     id);
 

diff --git a/libsoup/soup-uri.c b/libsoup/soup-uri.c
index 5fdf5a7..312a786 100644 (file)
--- a/libsoup/soup-uri.c
+++ b/libsoup/soup-uri.c
@@ -106,7 +106,6 @@ soup_uri_get_default_port (SoupProtocol proto)
 
 /**
  * soup_uri_new: create a SoupUri object from a string
- *
  * @uri_string: The string containing the URL to scan
  * 
  * This routine takes a gchar and parses it as a