Change G_LOG_DOMAIN to "libsoup". Remove unused defines.
authorDan Winship <danw@src.gnome.org>
Tue, 18 Nov 2003 20:00:08 +0000 (20:00 +0000)
committerDan Winship <danw@src.gnome.org>
Tue, 18 Nov 2003 20:00:08 +0000 (20:00 +0000)
* libsoup/Makefile.am (INCLUDES): Change G_LOG_DOMAIN to
"libsoup". Remove unused defines.

* libsoup/soup-connection.c: Fix doc comments
* libsoup/soup-message.c: Likewise
* libsoup/soup-misc.c: Likewise
* libsoup/soup-socket.c: Likewise
* libsoup/soup-uri.c: Likewise

* libsoup/soup-address.h: Fixes to please gtk-doc
* libsoup/soup-connection.h: Likewise
* libsoup/soup-message.h: Likewise
* libsoup/soup-message-private.h: Likewise
* libsoup/soup-misc.h: Likewise
* libsoup/soup-server-auth.h: Likewise
* libsoup/soup-socket.h: Likewise

14 files changed:
ChangeLog
libsoup/Makefile.am
libsoup/soup-address.h
libsoup/soup-connection.c
libsoup/soup-connection.h
libsoup/soup-message-private.h
libsoup/soup-message.c
libsoup/soup-message.h
libsoup/soup-misc.c
libsoup/soup-misc.h
libsoup/soup-server-auth.h
libsoup/soup-socket.c
libsoup/soup-socket.h
libsoup/soup-uri.c

index aa3a3f3..5330554 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,24 @@
 2003-11-18  Dan Winship  <danw@ximian.com>
 
+       * libsoup/Makefile.am (INCLUDES): Change G_LOG_DOMAIN to
+       "libsoup". Remove unused defines.
+
+       * libsoup/soup-connection.c: Fix doc comments
+       * libsoup/soup-message.c: Likewise
+       * libsoup/soup-misc.c: Likewise
+       * libsoup/soup-socket.c: Likewise
+       * libsoup/soup-uri.c: Likewise
+
+       * libsoup/soup-address.h: Fixes to please gtk-doc
+       * libsoup/soup-connection.h: Likewise
+       * libsoup/soup-message.h: Likewise
+       * libsoup/soup-message-private.h: Likewise
+       * libsoup/soup-misc.h: Likewise
+       * libsoup/soup-server-auth.h: Likewise
+       * libsoup/soup-socket.h: Likewise
+
+2003-11-18  Dan Winship  <danw@ximian.com>
+
        * configure.in: Fix up the SSL checks some. Remove some useless
        old header checks.
 
index 63787cf..4bd46c6 100644 (file)
@@ -1,9 +1,7 @@
 ## Process this file with automake to produce Makefile.in
 
 INCLUDES =                             \
-       -DG_LOG_DOMAIN=\"SOUP\"         \
-       -DSYSCONFDIR=\"$(sysconfdir)\"  \
-       -DLIBEXECDIR=\"$(libexecdir)\"  \
+       -DG_LOG_DOMAIN=\"libsoup\"      \
        -I$(top_srcdir)                 \
        $(SOUP_DEBUG_FLAGS)             \
        $(GLIB_CFLAGS)                  \
index b9946f5..24b08a3 100644 (file)
@@ -33,14 +33,20 @@ typedef struct {
        void (*dns_result) (SoupAddress *addr, guint status);
 } SoupAddressClass;
 
+/* This is messy, but gtk-doc doesn't understand if the #if occurs
+ * inside the typedef.
+ */
+#ifdef AF_INET6
 typedef enum {
        SOUP_ADDRESS_FAMILY_IPV4 = AF_INET,
-#ifdef AF_INET6
        SOUP_ADDRESS_FAMILY_IPV6 = AF_INET6
+} SoupAddressFamily;
 #else
+typedef enum {
+       SOUP_ADDRESS_FAMILY_IPV4 = AF_INET,
        SOUP_ADDRESS_FAMILY_IPV6 = -1
-#endif
 } SoupAddressFamily;
+#endif
 
 #define SOUP_ADDRESS_ANY_PORT 0
 
@@ -57,8 +63,8 @@ typedef void   (*SoupAddressCallback)            (SoupAddress         *addr,
                                                  guint                status,
                                                  gpointer             data);
 void             soup_address_resolve_async      (SoupAddress         *addr,
-                                                 SoupAddressCallback  cb,
-                                                 gpointer             data);
+                                                 SoupAddressCallback  callback,
+                                                 gpointer             user_data);
 guint            soup_address_resolve_sync       (SoupAddress         *addr);
 
 const char      *soup_address_get_name           (SoupAddress         *addr);
index 846169c..6352580 100644 (file)
@@ -355,7 +355,6 @@ socket_connect_result (SoupSocket *sock, guint status, gpointer user_data)
 /**
  * soup_connection_connect_async:
  * @conn: the connection
- * @ac: the async context to use
  * @callback: callback to call when the connection succeeds or fails
  * @user_data: data for @callback
  *
index d18ddbe..2d88b5a 100644 (file)
@@ -58,7 +58,7 @@ typedef void  (*SoupConnectionCallback)        (SoupConnection   *sock,
                                                gpointer          data);
 
 void            soup_connection_connect_async  (SoupConnection   *conn,
-                                               SoupConnectionCallback,
+                                               SoupConnectionCallback callback,
                                                gpointer          user_data);
 guint           soup_connection_connect_sync   (SoupConnection   *conn);
 
index 9c4efb3..1488867 100644 (file)
@@ -28,8 +28,6 @@ void             soup_message_run_handlers     (SoupMessage      *msg,
 void             soup_message_cleanup          (SoupMessage      *req);
 void             soup_message_cleanup_response (SoupMessage      *req);
 
-gboolean         soup_message_is_keepalive     (SoupMessage      *msg);
-
 
 typedef void     (*SoupMessageGetHeadersFn)  (SoupMessage      *msg,
                                              GString          *headers,
index ced536f..b06b0b6 100644 (file)
@@ -267,9 +267,9 @@ soup_message_set_request (SoupMessage   *msg,
  * soup_message_set_response:
  * @msg: the message
  * @content_type: MIME Content-Type of the body
- * @req_owner: the #SoupOwnership of the passed data buffer.
- * @req_body: a data buffer containing the body of the message response.
- * @req_length: the byte length of @req_body.
+ * @resp_owner: the #SoupOwnership of the passed data buffer.
+ * @resp_body: a data buffer containing the body of the message response.
+ * @resp_length: the byte length of @resp_body.
  * 
  * Convenience function to set the response body of a #SoupMessage
  */
index b5ee802..e576b12 100644 (file)
@@ -23,7 +23,7 @@ typedef enum {
        SOUP_MESSAGE_STATUS_QUEUED,
         SOUP_MESSAGE_STATUS_CONNECTING,
         SOUP_MESSAGE_STATUS_RUNNING,
-       SOUP_MESSAGE_STATUS_FINISHED,
+       SOUP_MESSAGE_STATUS_FINISHED
 } SoupMessageStatus;
 
 #define SOUP_MESSAGE_IS_STARTING(msg) (msg->status == SOUP_MESSAGE_STATUS_QUEUED || msg->status == SOUP_MESSAGE_STATUS_CONNECTING)
@@ -31,7 +31,7 @@ typedef enum {
 typedef enum {
        SOUP_TRANSFER_UNKNOWN = 0,
        SOUP_TRANSFER_CHUNKED,
-       SOUP_TRANSFER_CONTENT_LENGTH,
+       SOUP_TRANSFER_CONTENT_LENGTH
 } SoupTransferEncoding;
 
 typedef enum {
@@ -85,7 +85,7 @@ GType soup_message_get_type (void);
 typedef void (*SoupMessageCallbackFn) (SoupMessage *req, gpointer user_data);
 
 SoupMessage   *soup_message_new                 (const char        *method,
-                                                const char        *uri);
+                                                const char        *uri_string);
 SoupMessage   *soup_message_new_from_uri        (const char        *method,
                                                 const SoupUri     *uri);
 
@@ -93,15 +93,15 @@ void           soup_message_set_request         (SoupMessage       *msg,
                                                 const char        *content_type,
                                                 SoupOwnership      req_owner,
                                                 char              *req_body,
-                                                gulong             req_len);
+                                                gulong             req_length);
 
 void           soup_message_set_response        (SoupMessage       *msg,
                                                 const char        *content_type,
                                                 SoupOwnership      resp_owner,
                                                 char              *resp_body,
-                                                gulong             resp_len);
+                                                gulong             resp_length);
 
-void           soup_message_cancel              (SoupMessage       *req);
+void           soup_message_cancel              (SoupMessage       *msg);
 
 void           soup_message_add_header          (GHashTable        *hash,
                                                 const char        *name,
@@ -124,7 +124,7 @@ void           soup_message_clear_headers       (GHashTable        *hash);
 
 typedef enum {
        SOUP_HTTP_1_0 = 0,
-       SOUP_HTTP_1_1 = 1,
+       SOUP_HTTP_1_1 = 1
 } SoupHttpVersion;
 
 void             soup_message_set_http_version    (SoupMessage       *msg,
index eb284dd..82980bc 100644 (file)
@@ -189,7 +189,7 @@ soup_base64_encode_step (const guchar  *in,
 /**
  * soup_base64_encode:
  * @text: the binary data to encode.
- * @inlen: the length of @text.
+ * @len: the length of @text.
  *
  * Encode a sequence of binary data into it's Base-64 stringified
  * representation.
@@ -197,7 +197,7 @@ soup_base64_encode_step (const guchar  *in,
  * Return value: The Base-64 encoded string representing @text.
  */
 char *
-soup_base64_encode (const char *text, int inlen)
+soup_base64_encode (const char *text, int len)
 {
         unsigned char *out;
         int state = 0, outlen;
index 718bac1..c8b4e73 100644 (file)
@@ -39,7 +39,7 @@ int                soup_base64_decode_step   (const guchar *in,
 /* Misc utils */
 
 guint              soup_signal_connect_once  (gpointer      instance,
-                                             const char   *signal,
+                                             const char   *detailed_signal,
                                              GCallback     c_handler,
                                              gpointer      data);
 
index b50412b..a413a6a 100644 (file)
@@ -38,7 +38,7 @@ void soup_server_auth_context_challenge (SoupServerAuthContext *auth_ctx,
 
 typedef enum {
        SOUP_AUTH_TYPE_BASIC = 1,
-       SOUP_AUTH_TYPE_DIGEST,
+       SOUP_AUTH_TYPE_DIGEST
 } SoupAuthType;
 
 typedef struct {
index f390601..9e6cc9a 100644 (file)
@@ -308,6 +308,8 @@ get_property (GObject *object, guint prop_id,
 
 /**
  * soup_socket_new:
+ * @optname1: name of first property to set (or %NULL)
+ * @...: value of @optname1, followed by additional property/value pairs
  *
  * Return value: a new (disconnected) socket
  **/
@@ -578,7 +580,7 @@ soup_socket_listen (SoupSocket *sock, SoupAddress *local_addr)
 
 /**
  * soup_socket_start_ssl:
- * @socket: the socket
+ * @sock: the socket
  *
  * Starts using SSL on @socket.
  *
@@ -960,7 +962,7 @@ socket_write_watch (GIOChannel *chan, GIOCondition condition, gpointer user_data
  * @sock: the socket
  * @buffer: data to write
  * @len: size of @buffer, in bytes
- * @nwrite: on return, number of bytes written
+ * @nwrote: on return, number of bytes written
  *
  * Attempts to write @len bytes from @buffer to @sock. If some data is
  * successfully written, the resturn status will be
index afefde5..20c4fea 100644 (file)
@@ -47,7 +47,7 @@ SoupSocket    *soup_socket_new                (const char         *optname1,
                                               ...);
 
 guint          soup_socket_connect            (SoupSocket         *sock,
-                                              SoupAddress        *rem_addr);
+                                              SoupAddress        *remote_addr);
 gboolean       soup_socket_listen             (SoupSocket         *sock,
                                               SoupAddress        *local_addr);
 gboolean       soup_socket_start_ssl          (SoupSocket         *sock);
@@ -70,10 +70,10 @@ SoupSocket    *soup_socket_client_new_async   (const char         *hostname,
 SoupSocket    *soup_socket_client_new_sync    (const char         *hostname,
                                               guint               port,
                                               gpointer            ssl_creds,
-                                              guint              *status);
+                                              guint              *status_ret);
 SoupSocket    *soup_socket_server_new         (SoupAddress        *local_addr,
                                               gpointer            ssl_creds,
-                                              SoupSocketListenerCallback,
+                                              SoupSocketListenerCallback callback,
                                               gpointer            user_data);
 
 SoupAddress   *soup_socket_get_local_address  (SoupSocket         *sock);
index 3d7b7ab..5461bbb 100644 (file)
@@ -420,6 +420,8 @@ append_uri_encoded (GString *str, const char *in, const char *extra_enc_chars)
  *
  * This %-encodes the given URI part and returns the escaped version
  * in allocated memory, which the caller must free when it is done.
+ *
+ * Return value: the encoded URI part
  **/
 char *
 soup_uri_encode (const char *part, const char *escape_extra)