summaryrefslogtreecommitdiff
path: root/include/asterisk/musiconhold.h
diff options
context:
space:
mode:
authorRichard Mudgett <rmudgett@digium.com>2013-08-22 21:29:16 +0000
committerRichard Mudgett <rmudgett@digium.com>2013-08-22 21:29:16 +0000
commitc02c1b6f53797da8bfe2e679a34512cb4b2da652 (patch)
tree95c3aa60b6454829504a57b7fef0f0bb66bdb4bc /include/asterisk/musiconhold.h
parent9520df86fd805bf5a77b5cbf02010e3d35265656 (diff)
Update MOH start/stop routine doxygen.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397482 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/musiconhold.h')
-rw-r--r--include/asterisk/musiconhold.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/asterisk/musiconhold.h b/include/asterisk/musiconhold.h
index 480f2ff8e..46cdc1f04 100644
--- a/include/asterisk/musiconhold.h
+++ b/include/asterisk/musiconhold.h
@@ -28,20 +28,21 @@ extern "C" {
#endif
/*!
- * \brief Turn on music on hold on a given channel
+ * \brief Turn on music on hold on a given channel
*
* \param chan The channel structure that will get music on hold
* \param mclass The class to use if the musicclass is not currently set on
- * the channel structure.
+ * the channel structure. NULL and the empty string are equivalent.
* \param interpclass The class to use if the musicclass is not currently set on
* the channel structure or in the mclass argument.
+ * NULL and the empty string are equivalent.
*
* \retval Zero on success
* \retval non-zero on failure
*/
int ast_moh_start(struct ast_channel *chan, const char *mclass, const char *interpclass);
-/*! Turn off music on hold on a given channel */
+/*! \brief Turn off music on hold on a given channel */
void ast_moh_stop(struct ast_channel *chan);
void ast_install_music_functions(int (*start_ptr)(struct ast_channel *, const char *, const char *),