diff options
| author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-07-16 02:51:56 +0000 |
|---|---|---|
| committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-07-16 02:51:56 +0000 |
| commit | 2bf80313d6f8f29e2c9aa74c562e1d1e6c37e6a1 (patch) | |
| tree | f0062ea7e0d09f192e6cb5de75bb1491fb5809b7 /include/asterisk/dundi.h | |
| parent | 040609f7b5461bdd67e800aa18ad43bd590ac2e5 (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/dundi.h')
| -rw-r--r-- | include/asterisk/dundi.h | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/include/asterisk/dundi.h b/include/asterisk/dundi.h index 9290536d6..e588338ae 100644 --- a/include/asterisk/dundi.h +++ b/include/asterisk/dundi.h @@ -18,7 +18,7 @@ /*! \file * \brief Distributed Universal Number Discovery (DUNDi) - * See also \ref AstDUNDi + * See also \arg \ref AstDUNDi */ #ifndef _ASTERISK_DUNDI_H @@ -213,8 +213,13 @@ struct dundi_entity_info { char ipaddr[80]; }; -/*! \brief Lookup the given number in the given dundi context (or e164 if unspecified) using the given callerid (if specified) and return up to maxret results in the array specified. - returns the number of results found or -1 on a hangup of teh channel. */ +/*! + * \brief Lookup the given number in the given dundi context. + * Lookup number in a given dundi context (if unspecified use e164), the given callerid (if specified) + * and return up to maxret results in the array specified. + * \retval the number of results found. + * \retval -1 on a hangup of the channel. +*/ int dundi_lookup(struct dundi_result *result, int maxret, struct ast_channel *chan, const char *dcontext, const char *number, int nocache); /*! \brief Retrieve information on a specific EID */ |