summaryrefslogtreecommitdiff
path: root/include/asterisk/app.h
diff options
context:
space:
mode:
authorRichard Mudgett <rmudgett@digium.com>2013-11-21 19:09:45 +0000
committerRichard Mudgett <rmudgett@digium.com>2013-11-21 19:09:45 +0000
commit00e9a136bbd6d5b8e5e7933730b7a2a611c78e4a (patch)
treeb16b77b2efe3ed786656663f8f853c05e53b8c3f /include/asterisk/app.h
parentf62373b7a3dd0dd655da7ee1d2df2b4fcac43ceb (diff)
voicemail: Fixup some doxygen comments.
........ Merged revisions 402956 from http://svn.asterisk.org/svn/asterisk/branches/12 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@402957 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/app.h')
-rw-r--r--include/asterisk/app.h13
1 files changed, 8 insertions, 5 deletions
diff --git a/include/asterisk/app.h b/include/asterisk/app.h
index c47c4d379..3a2ea17a3 100644
--- a/include/asterisk/app.h
+++ b/include/asterisk/app.h
@@ -334,7 +334,8 @@ typedef void (ast_vm_msg_play_cb)(struct ast_channel *chan, const char *playfile
/*!
* \brief Determines if the given folder has messages.
*
- * \param mailbox The @ delimited string for user@context. If no context is found, uses 'default' for the context.
+ * \param mailbox Comma or & delimited list of mailboxes (user@context).
+ * If no context is found, uses 'default' for the context.
* \param folder The folder to look in. Default is INBOX if not provided.
*
* \retval 1 if the folder has one or more messages.
@@ -345,7 +346,8 @@ typedef int (ast_has_voicemail_fn)(const char *mailbox, const char *folder);
/*!
* \brief Gets the number of messages that exist for the mailbox list.
*
- * \param mailbox Comma or space deliminated list of mailboxes (user@context).
+ * \param mailbox Comma or space delimited list of mailboxes (user@context).
+ * If no context is found, uses 'default' for the context.
* \param newmsgs Where to put the count of new messages. (Can be NULL)
* \param oldmsgs Where to put the count of old messages. (Can be NULL)
*
@@ -361,7 +363,8 @@ typedef int (ast_inboxcount_fn)(const char *mailbox, int *newmsgs, int *oldmsgs)
/*!
* \brief Gets the number of messages that exist for the mailbox list.
*
- * \param mailbox Comma or space deliminated list of mailboxes (user@context).
+ * \param mailbox Comma or space delimited list of mailboxes (user@context).
+ * If no context is found, uses 'default' for the context.
* \param urgentmsgs Where to put the count of urgent messages. (Can be NULL)
* \param newmsgs Where to put the count of new messages. (Can be NULL)
* \param oldmsgs Where to put the count of old messages. (Can be NULL)
@@ -430,7 +433,7 @@ typedef const char *(ast_vm_index_to_foldername_fn)(int id);
* \param mailbox The user part of user@context.
* \param context The context part of user@context. Must be explicit.
* \param folder When not NULL only msgs from the specified folder will be included.
- * \param desending list the msgs in descending order rather than ascending order.
+ * \param descending list the msgs in descending order rather than ascending order.
* \param sort_val What to sort in the snapshot.
* \param combine_INBOX_and_OLD When this argument is set, The OLD folder will be represented
* in the INBOX folder of the snapshot. This allows the snapshot to represent the
@@ -658,7 +661,7 @@ const char *ast_vm_index_to_foldername(int id);
* \param mailbox, the mailbox to look for
* \param context, the context to look for the mailbox in
* \param folder, OPTIONAL. When not NULL only msgs from the specified folder will be included.
- * \param desending, list the msgs in descending order rather than ascending order.
+ * \param descending, list the msgs in descending order rather than ascending order.
* \param combine_INBOX_and_OLD, When this argument is set, The OLD folder will be represented
* in the INBOX folder of the snapshot. This allows the snapshot to represent the
* OLD and INBOX messages in sorted order merged together.