net: Correct \return text of parse_url().
authorAndre Noll <maan@systemlinux.org>
Fri, 6 Sep 2013 20:21:33 +0000 (20:21 +0000)
committerAndre Noll <maan@systemlinux.org>
Sun, 22 Dec 2013 16:39:20 +0000 (16:39 +0000)
The parameter is called port rather than portnum. Reformat
the paragraph and fix the font type of NULL while we are at
it.

net.c

diff --git a/net.c b/net.c
index 4a31f01..e9b5ed1 100644 (file)
--- a/net.c
+++ b/net.c
@@ -142,9 +142,9 @@ static bool host_string_ok(const char *host)
  * \param hostlen The maximum length of \a host.
  * \param port   To return the port number (if any) of \a url.
  *
- * \return Pointer to \a host, or NULL if failed.
- * If NULL is returned, \a host and \a portnum are undefined. If no
- * port number was present in \a url, \a portnum is set to -1.
+ * \return Pointer to \a host, or \p NULL if failed.  If \p NULL is returned,
+ * \a host and \a port are undefined. If no port number was present in \a url,
+ * \a port is set to -1.
  *
  * \sa RFC 3986, 3.2.2/3.2.3
  */