[svn-commits] wdoekes: trunk r345162 - in /trunk: ./ channels/sip/include/reqresp_parser.h

[SVN commits to the Digium repositories]

Author: wdoekes
Date: Mon Nov 14 13:03:29 2011
New Revision: 345162

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=345162
Log:
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

Modified:
    trunk/   (props changed)
    trunk/channels/sip/include/reqresp_parser.h

Propchange: trunk/
------------------------------------------------------------------------------
Binary property 'branch-10-merged' - no diff available.

Modified: trunk/channels/sip/include/reqresp_parser.h
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/sip/include/reqresp_parser.h?view=diff&rev=345162&r1=345161&r2=345162
==============================================================================
--- trunk/channels/sip/include/reqresp_parser.h (original)
+++ trunk/channels/sip/include/reqresp_parser.h Mon Nov 14 13:03:29 2011
@@ -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.