aboutsummaryrefslogtreecommitdiffstats
path: root/include/asterisk/enum.h
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2007-07-16 02:51:56 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2007-07-16 02:51:56 +0000
commit2bf80313d6f8f29e2c9aa74c562e1d1e6c37e6a1 (patch)
treef0062ea7e0d09f192e6cb5de75bb1491fb5809b7 /include/asterisk/enum.h
parent040609f7b5461bdd67e800aa18ad43bd590ac2e5 (diff)
Merge a bunch of doxygen updates to header files. This includes changes to
use the \retval tag for documenting return values, fixing various warnings when generating the documentation, and various other things. (closes issue #10203, snuffy) git-svn-id: http://svn.digium.com/svn/asterisk/trunk@75164 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/enum.h')
-rw-r--r--include/asterisk/enum.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/asterisk/enum.h b/include/asterisk/enum.h
index 954eba452..d6bbea294 100644
--- a/include/asterisk/enum.h
+++ b/include/asterisk/enum.h
@@ -52,7 +52,7 @@ struct enum_context {
};
-/*! \brief Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup
+/*! \brief Lookup entry in ENUM
\param chan Channel
\param number E164 number with or without the leading +
\param location Number returned (or SIP uri)
@@ -65,6 +65,9 @@ struct enum_context {
\param options Options ('c' to count number of NAPTR RR)
\param record The position of required RR in the answer list
\param argcontext Argument for caching results into an enum_context pointer (NULL is used for not caching)
+ \retval 1 if found
+ \retval 0 if not found
+ \retval -1 on hangup
*/
int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology,
int maxtech, char* suffix, char* options, unsigned int record, struct enum_context **argcontext);