diff options
| author | Russell Bryant <russell@russellbryant.com> | 2010-02-07 20:57:42 +0000 |
|---|---|---|
| committer | Russell Bryant <russell@russellbryant.com> | 2010-02-07 20:57:42 +0000 |
| commit | f199367b9302dc9d7c4b9453958e9522d23eddfd (patch) | |
| tree | c56b2d4ec144f22cc2361e1697ee3d8d6430cfaf /channels/sip/include/sip_utils.h | |
| parent | 2191c94336255e4d8ca2b09f7b2221f43d65af69 (diff) | |
Tweak formatting and add minor updates to some comments.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@245269 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'channels/sip/include/sip_utils.h')
| -rw-r--r-- | channels/sip/include/sip_utils.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/channels/sip/include/sip_utils.h b/channels/sip/include/sip_utils.h index 3a91564d1..86eb81933 100644 --- a/channels/sip/include/sip_utils.h +++ b/channels/sip/include/sip_utils.h @@ -22,12 +22,14 @@ #ifndef _SIP_UTILS_H #define _SIP_UTILS_H - -/*! \brief converts ascii port to int representation. If no - * pt buffer is provided or the pt has errors when being converted - * to an int value, the port provided as the standard is used. +/*! + * \brief converts ascii port to int representation. + * + * \arg pt[in] string that contains a port. + * \arg standard[in] port to return in case the port string input is NULL + * or if there is a parsing error. * - * \retval positive numeric port + * \return An integer port representation. */ unsigned int port_str2int(const char *pt, unsigned int standard); |