From: Walter Doekes <walter+asterisk@wjd.nu>
Date: Mon, 14 Nov 2011 19:01:59 +0000 (+0000)
Subject: Update reqresp_parser parse_uri doxygen comments.
X-Git-Tag: 10.1.0-rc1~85
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ce88defd3c6bc4518ec8091d945fbd85aaa04d7e;p=thirdparty%2Fasterisk.git

Update reqresp_parser parse_uri doxygen comments.

The issue mentioned in the bug report had been fixed recently by
twilson. The reporter included this documentation fix.

(closes issue ASTERISK-18572)
Reported by: Richard Miller
Patch by: Richard Miller (modified)
........

Merged revisions 345160 from http://svn.asterisk.org/svn/asterisk/branches/1.8


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/10@345161 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/channels/sip/include/reqresp_parser.h b/channels/sip/include/reqresp_parser.h
index f0ab86e388..9dfec7d391 100644
--- a/channels/sip/include/reqresp_parser.h
+++ b/channels/sip/include/reqresp_parser.h
@@ -29,11 +29,13 @@
  * - Multiple scheme's can be specified ',' delimited. ex: "sip:,sips:"
  * - If a component is not requested, do not split around it. This means
  *   that if we don't have domain, we cannot split name:pass.
- * - It is safe to call with ret_name, pass, domain, port pointing all to
+ * - It is safe to call with ret_name, pass, hostport pointing all to
  *   the same place.
- * - If no secret parameter is provided, ret_name will return with both parts, user:secret
- * - If no port parameter is provided, domain will return with both parts, domain:port
- * - This function overwrites the the uri string.
+ * - If no secret parameter is provided, ret_name will return with both
+ *   parts, user:secret.
+ * - If the URI contains a port number, hostport will return with both
+ *   parts, host:port.
+ * - This function overwrites the the URI string.
  * 
  * \retval 0 on success
  * \retval -1 on error.