[asterisk-commits] tilghman: trunk r85633 - /trunk/funcs/func_strings.c

[SVN commits to the Asterisk project]

Author: tilghman
Date: Mon Oct 15 12:51:05 2007
New Revision: 85633

URL: http://svn.digium.com/view/asterisk?view=rev&rev=85633
Log:
Document my changes from Friday

Modified:
    trunk/funcs/func_strings.c

Modified: trunk/funcs/func_strings.c
URL: http://svn.digium.com/view/asterisk/trunk/funcs/func_strings.c?view=diff&rev=85633&r1=85632&r2=85633
==============================================================================
--- trunk/funcs/func_strings.c (original)
+++ trunk/funcs/func_strings.c Mon Oct 15 12:51:05 2007
@@ -223,6 +223,13 @@
 	.synopsis = "Filter the string to include only the allowed characters",
 	.syntax = "FILTER(<allowed-chars>,<string>)",
 	.read = filter,
+	.desc =
+"Permits all characters listed in <allowed-chars>, filtering all others out.\n"
+"In addition to literally listing the characters, you may also use ranges of\n"
+"characters (delimited by a '-'), as well as hexadecimal characters started\n"
+"with a \\x (i.e. \\x20) and octal characters started with \\0 (i.e. \\040).\n"
+"Also, \\t, \\n, and \\r are recognized.  If you want a literal '-' character,\n"
+"simply prefix it with a '\\'\n",
 };
 
 static int regex(struct ast_channel *chan, const char *cmd, char *parse, char *buf,