[libsoup] docs: Fix misc minor warnings



commit 3485d82b7fc4451006f9b5a94fe143efab9b2a9d
Author: Patrick Griffis <pgriffis igalia com>
Date:   Tue Nov 3 13:50:26 2020 -0600

    docs: Fix misc minor warnings

 libsoup/server/soup-message-body.c   | 4 ++--
 libsoup/server/soup-server-message.c | 2 +-
 libsoup/server/soup-server.c         | 2 +-
 libsoup/soup-method.h                | 8 ++++----
 libsoup/soup-session.c               | 2 +-
 5 files changed, 9 insertions(+), 9 deletions(-)
---
diff --git a/libsoup/server/soup-message-body.c b/libsoup/server/soup-message-body.c
index e9925011..321f4075 100644
--- a/libsoup/server/soup-message-body.c
+++ b/libsoup/server/soup-message-body.c
@@ -91,13 +91,13 @@ soup_message_body_new (void)
  * @accumulate: whether or not to accumulate body chunks in @body
  *
  * Sets or clears the accumulate flag on @body. (The default value is
- * %TRUE.) If set to %FALSE, @body's %data field will not be filled in
+ * %TRUE.) If set to %FALSE, @body's data field will not be filled in
  * after the body is fully sent/received, and the chunks that make up
  * @body may be discarded when they are no longer needed.
  *
  * If you set the flag to %FALSE on the #SoupMessage request_body of a
  * client-side message, it will block the accumulation of chunks into
- * @body's %data field, but it will not normally cause the chunks to
+ * @body's data field, but it will not normally cause the chunks to
  * be discarded after being written like in the server-side
  * #SoupMessage response_body case, because the request body needs to
  * be kept around in case the request needs to be sent a second time
diff --git a/libsoup/server/soup-server-message.c b/libsoup/server/soup-server-message.c
index 7406d757..e376749e 100644
--- a/libsoup/server/soup-server-message.c
+++ b/libsoup/server/soup-server-message.c
@@ -856,7 +856,7 @@ soup_server_message_get_remote_host (SoupServerMessage *msg)
  * #SoupServer. This happens immediately, regardless of the current
  * state of the connection; if the response to @msg has not yet finished
  * being sent, then it will be discarded; you can steal the connection from a
- * #SoupServerMessage:wrote-informational or #SoupServerMessage:wrote-body signal
+ * #SoupServerMessage::wrote-informational or #SoupServerMessage::wrote-body signal
  * handler if you need to wait for part or all of the response to be sent.
  *
  * Note that when calling this function from C, @msg will most
diff --git a/libsoup/server/soup-server.c b/libsoup/server/soup-server.c
index 03157f92..f180e366 100644
--- a/libsoup/server/soup-server.c
+++ b/libsoup/server/soup-server.c
@@ -1641,7 +1641,7 @@ get_or_create_handler (SoupServer *server, const char *exact_path)
  * be used for that case.)
  *
  * For requests under @path (that have not already been assigned a
- * status code by a #SoupAuthDomain, an early #SoupServerHandler, or a
+ * status code by a #SoupAuthDomain, an early server handler, or a
  * signal handler), @callback will be invoked after receiving the
  * request body; the message's #SoupMessage:method,
  * #SoupMessage:request-headers, and #SoupMessage:request-body fields
diff --git a/libsoup/soup-method.h b/libsoup/soup-method.h
index 952d4b6b..2cf5231f 100644
--- a/libsoup/soup-method.h
+++ b/libsoup/soup-method.h
@@ -19,11 +19,11 @@ G_BEGIN_DECLS
  * arbitrary strings to soup_message_new() if you prefer.
  * 
  * The thing that these defines <emphasis>are</emphasis> useful for is
- * performing quick comparisons against #SoupMessage's %method field;
- * because that field always contains an interned string, and these
- * macros return interned strings, you can compare %method directly
+ * performing quick comparisons against soup_message_get_method();
+ * because #SoupMessage always contains an interned string, and these
+ * macros return interned strings, you can compare methods directly
  * against these macros rather than needing to use strcmp(). This is
- * most useful in SoupServer handlers. Eg:
+ * most useful in #SoupServer handlers. Eg:
  * 
  * <informalexample><programlisting>
  *     if (soup_message_get_method (msg) != SOUP_METHOD_GET &amp;&amp; soup_message_get_method (msg) != 
SOUP_METHOD_HEAD) {
diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c
index 011b4666..76f3ea88 100644
--- a/libsoup/soup-session.c
+++ b/libsoup/soup-session.c
@@ -68,7 +68,7 @@
 /**
  * SoupSession:
  *
- * Class managing options and state for #SoupMessages.
+ * Class managing options and state for #SoupMessage<!-- -->s.
  */
 
 typedef struct {


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