diff options
| author | Walter Doekes <walter+asterisk@wjd.nu> | 2011-11-14 19:03:29 +0000 |
|---|---|---|
| committer | Walter Doekes <walter+asterisk@wjd.nu> | 2011-11-14 19:03:29 +0000 |
| commit | 6ef49c32147c7fdc28d72f0f2c117dfb591e3d50 (patch) | |
| tree | 5bf4be9a3521fe4b01684598c79bd14c43849172 | |
| parent | ec237d2e4a4c100c1a7ee87ec7a916c12cd5cd9a (diff) | |
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
........
Merged revisions 345161 from http://svn.asterisk.org/svn/asterisk/branches/10
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@345162 65c4cc65-6c06-0410-ace0-fbb531ad65f3
| -rw-r--r-- | channels/sip/include/reqresp_parser.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/channels/sip/include/reqresp_parser.h b/channels/sip/include/reqresp_parser.h index f0ab86e38..9dfec7d39 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. |