aboutsummaryrefslogtreecommitdiffstats
path: root/funcs/func_blacklist.c
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
commitb1f91b97d2085cc845d0f57bd9907de50c995105 (patch)
tree9c836ac808552d20be6bd2baa3a3c29f642eda53 /funcs/func_blacklist.c
parentc5d084051f21e943fcbcc347fc80b166885f298d (diff)
Merge changes from team/group/appdocsxml
This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: http://svn.digium.com/svn/asterisk/trunk@153365 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'funcs/func_blacklist.c')
-rw-r--r--funcs/func_blacklist.c17
1 files changed, 14 insertions, 3 deletions
diff --git a/funcs/func_blacklist.c b/funcs/func_blacklist.c
index 2a2fa78c7..c353b20fd 100644
--- a/funcs/func_blacklist.c
+++ b/funcs/func_blacklist.c
@@ -35,6 +35,20 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/channel.h"
#include "asterisk/astdb.h"
+/*** DOCUMENTATION
+ <function name="BLACKLIST" language="en_US">
+ <synopsis>
+ Check if the callerid is on the blacklist.
+ </synopsis>
+ <syntax />
+ <description>
+ <para>Uses astdb to check if the Caller*ID is in family <literal>blacklist</literal>.
+ Returns <literal>1</literal> or <literal>0</literal>.</para>
+ </description>
+ </function>
+
+***/
+
static int blacklist_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
{
char blacklist[1];
@@ -55,9 +69,6 @@ static int blacklist_read(struct ast_channel *chan, const char *cmd, char *data,
static struct ast_custom_function blacklist_function = {
.name = "BLACKLIST",
- .synopsis = "Check if the callerid is on the blacklist",
- .desc = "Uses astdb to check if the Caller*ID is in family 'blacklist'. Returns 1 or 0.\n",
- .syntax = "BLACKLIST()",
.read = blacklist_read,
};