serf-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Branko ─îibej <br...@apache.org>
Subject [PATCH] Fix minor typos in public API docstrings
Date Tue, 25 Oct 2016 17:19:08 GMT
Here's a tiny docstring fix in serf.h. The patch applies to both trunk
an 1.3.x.

-- Brane

[[[
* serf.h (serf_connection_create): Fix markup typos in docstring.
]]]
Index: serf.h

===================================================================
--- serf.h	(revision 1766551)
+++ serf.h	(working copy)
@@ -444,7 +444,7 @@ typedef apr_status_t (*serf_credentials_callback_t
  * If no proxy server is configured, a connection will be created to
  * (eventually) connect to the address specified by @a address. The address must
  * live at least as long as @a pool (thus, as long as the connection object).
- * If a proxy server is configured, @address will be ignored.
+ * If a proxy server is configured, @a address will be ignored.
  *
  * The connection object will be allocated within @a pool. Clearing or
  * destroying this pool will close the connection, and terminate any
@@ -457,7 +457,7 @@ typedef apr_status_t (*serf_credentials_callback_t
  * NULL may be passed for @a acceptor and @a closed; default implementations
  * will be used.
  *
- * Note: the connection is not made immediately. It will be opened on
+ * @note The connection is not made immediately. It will be opened on
  * the next call to @see serf_context_run.
  */
 serf_connection_t *serf_connection_create(


Mime
View raw message