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/config_parser.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/config_parser.h')
| -rw-r--r-- | channels/sip/include/config_parser.h | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/channels/sip/include/config_parser.h b/channels/sip/include/config_parser.h index 128c24118..0b86188c6 100644 --- a/channels/sip/include/config_parser.h +++ b/channels/sip/include/config_parser.h @@ -24,27 +24,33 @@ #ifndef _SIP_CONF_PARSE_H #define _SIP_CONF_PARSE_H - -/*! \brief Parse register=> line in sip.conf +/*! + * \brief Parse register=> line in sip.conf * - * \retval 0 on success - * \retval -1 on failure + * \retval 0 on success + * \retval -1 on failure */ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const char *value, int lineno); /*! * \brief parses a config line for a host with a transport - * i.e. tls://www.google.com:8056 * - * \retval 0 on success - * \retval -1 on failure + * An example input would be: + * <code>tls://www.google.com:8056</code> + * + * \retval 0 on success + * \retval -1 on failure */ int sip_parse_host(char *line, int lineno, char **hostname, int *portnum, enum sip_transport *transport); -/*! \brief register config parsing tests */ +/*! + * \brief register config parsing tests + */ void sip_config_parser_register_tests(void); -/*! \brief unregister config parsing tests */ +/*! + * \brief unregister config parsing tests + */ void sip_config_parser_unregister_tests(void); #endif |