diff options
author | markster <markster@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-03-02 05:17:13 +0000 |
---|---|---|
committer | markster <markster@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-03-02 05:17:13 +0000 |
commit | c1d769276103330ff68531633df7eb22f39f3da5 (patch) | |
tree | 75416b7f81653fc398400c3f18814087205b3278 /include/asterisk/enum.h | |
parent | 2e5cc3c5e270fac3bf67507728e0770cd6cb5059 (diff) |
Fix ENUM documentation (bug #3698)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@5115 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/enum.h')
-rwxr-xr-x | include/asterisk/enum.h | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/include/asterisk/enum.h b/include/asterisk/enum.h index 9d45b3a93..d2d8a134b 100755 --- a/include/asterisk/enum.h +++ b/include/asterisk/enum.h @@ -3,19 +3,42 @@ * * ENUM support * - * Copyright (C) 1999, Mark Spencer + * Copyright (C) 1999-2005, Digium, inc * - * Mark Spencer <markster@linux-support.net> + * Mark Spencer <markster@digium.com> * * This program is free software, distributed under the terms of * the GNU General Public License */ +/*! \file enum.h + \brief DNS and ENUM functions +*/ + #ifndef _ASTERISK_ENUM_H #define _ASTERISK_ENUM_H #include <asterisk/channel.h> -/* Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup */ +/*! \brief Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup + \param chan Channel + \param number Number in E164 format without the + (for e164.arpa) or format + requested by enum service used (enum.conf) + \param location Number returned (or SIP uri) + \param maxloc Max length + \param tech Technology (from url scheme in response) + \param maxtech Max length +*/ extern int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech); + +/*! \brief Lookup DNS TXT record (used by app TXTCIDnum + \param chan Channel + \param number E164 number without the + + \param locatio Number returned (or SIP uri) + \param maxloc Max length of number + \param tech Technology (not used in TXT records) + \param maxtech Max length + \param txt Text string (return value) + \param maxtxt Max length of "txt" +*/ extern int ast_get_txt(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech, char *txt, int maxtxt); extern int ast_enum_init(void); |