diff options
| author | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
|---|---|---|
| committer | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
| commit | 5b168ee34babe562be856ec8f1dd14c0abd7c1a5 (patch) | |
| tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /funcs/func_base64.c | |
| parent | 1fef0f63bbbde9530837995c8790b839f73b74e7 (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: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'funcs/func_base64.c')
| -rw-r--r-- | funcs/func_base64.c | 35 |
1 files changed, 29 insertions, 6 deletions
diff --git a/funcs/func_base64.c b/funcs/func_base64.c index 0849e9539..28805b943 100644 --- a/funcs/func_base64.c +++ b/funcs/func_base64.c @@ -30,6 +30,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/pbx.h" /* function register/unregister */ #include "asterisk/utils.h" +/*** DOCUMENTATION + <function name="BASE64_ENCODE" language="en_US"> + <synopsis> + Encode a string in base64. + </synopsis> + <syntax> + <parameter name="string" required="true"> + <para>Input string</para> + </parameter> + </syntax> + <description> + <para>Returns the base64 string.</para> + </description> + </function> + <function name="BASE64_DECODE" language="en_US"> + <synopsis> + Decode a base64 string. + </synopsis> + <syntax> + <parameter name="string" required="true"> + <para>Input string.</para> + </parameter> + </syntax> + <description> + <para>Returns the plain text string.</para> + </description> + </function> + ***/ + static int base64_encode(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { @@ -58,17 +87,11 @@ static int base64_decode(struct ast_channel *chan, const char *cmd, char *data, static struct ast_custom_function base64_encode_function = { .name = "BASE64_ENCODE", - .synopsis = "Encode a string in base64", - .desc = "Returns the base64 string\n", - .syntax = "BASE64_ENCODE(<string>)", .read = base64_encode, }; static struct ast_custom_function base64_decode_function = { .name = "BASE64_DECODE", - .synopsis = "Decode a base64 string", - .desc = "Returns the plain text string\n", - .syntax = "BASE64_DECODE(<base64_string>)", .read = base64_decode, }; |