[svn-commits] rmudgett: branch 12 r402956 - /branches/12/include/asterisk/app.h

[SVN commits to the Digium repositories]

Author: rmudgett
Date: Thu Nov 21 13:08:40 2013
New Revision: 402956

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=402956
Log:
voicemail: Fixup some doxygen comments.

Modified:
    branches/12/include/asterisk/app.h

Modified: branches/12/include/asterisk/app.h
URL: http://svnview.digium.com/svn/asterisk/branches/12/include/asterisk/app.h?view=diff&rev=402956&r1=402955&r2=402956
==============================================================================
--- branches/12/include/asterisk/app.h (original)
+++ branches/12/include/asterisk/app.h Thu Nov 21 13:08:40 2013
@@ -334,7 +334,8 @@
 /*!
  * \brief Determines if the given folder has messages.
  *
- * \param mailbox The @ delimited string for user at context. If no context is found, uses 'default' for the context.
+ * \param mailbox Comma or & delimited list of mailboxes (user at 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 @@
 /*!
  * \brief Gets the number of messages that exist for the mailbox list.
  *
- * \param mailbox Comma or space deliminated list of mailboxes (user at context).
+ * \param mailbox Comma or space delimited list of mailboxes (user at 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 @@
 /*!
  * \brief Gets the number of messages that exist for the mailbox list.
  *
- * \param mailbox Comma or space deliminated list of mailboxes (user at context).
+ * \param mailbox Comma or space delimited list of mailboxes (user at 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 @@
  * \param mailbox The user part of user at context.
  * \param context The context part of user at 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 @@
  * \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.