Add some documentation detailing an aspect of dialplan functions, as requested by Russell

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@77838 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Tilghman Lesher
2007-07-31 18:50:06 +00:00
parent ce26bea24a
commit 3257acb922
2 changed files with 7 additions and 2 deletions

View File

@@ -200,8 +200,9 @@ static struct ast_custom_function unlock_function = {
.name = "UNLOCK",
.synopsis = "Unlocks a named mutex",
.desc =
"Unlocks a previously locked mutex. Returns 1 if the channel had a lock\n"
"or 0 otherwise.\n",
"Unlocks a previously locked mutex. Note that it is generally unnecessary to\n"
"unlock in a hangup routine, as any lock held is automatically freed when the\n"
"channel is destroyed. Returns 1 if the channel had a lock or 0 otherwise.\n",
.syntax = "UNLOCK()",
.read = unlock_read,
};