aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2009-10-21 16:02:12 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2009-10-21 16:02:12 +0000
commit1108195e5b2814451ec22c190be7d0ca2d9ead10 (patch)
tree233fc1c8f5d9bd9ffedc123671b0cea898b45e93 /include
parent97ce3dbf31ec080fbaa0374e8096213c360c2c21 (diff)
Fix documentation for ast_softhangup() and correct the misuse thereof.
(closes issue #16103) Reported by: majorbloodnok git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@225105 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/channel.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
index 2a835c96c..42e473b70 100644
--- a/include/asterisk/channel.h
+++ b/include/asterisk/channel.h
@@ -774,14 +774,14 @@ int ast_hangup(struct ast_channel *chan);
* \param chan channel to be soft-hung-up
* Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
* safely hangup a channel managed by another thread.
- * \param cause Ast hangupcause for hangup
+ * \param reason an AST_SOFTHANGUP_* reason code
* \return Returns 0 regardless
*/
int ast_softhangup(struct ast_channel *chan, int cause);
/*! \brief Softly hangup up a channel (no channel lock)
* \param chan channel to be soft-hung-up
- * \param cause Ast hangupcause for hangup (see cause.h) */
+ * \param reason an AST_SOFTHANGUP_* reason code */
int ast_softhangup_nolock(struct ast_channel *chan, int cause);
/*! \brief Check to see if a channel is needing hang up