kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

parking.h: Update ast_parking_park_call() doxygen to reality.

Browse Source 
ASTERISK-26029

Change-Id: I2db14d102a48d3224010e6d1c69e856373cc1260
This commit is contained in:
Richard Mudgett
2016-05-20 16:59:52 -05:00
parent ddcf983e39
commit 9453d1187a
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
include/asterisk/parking.h
View File

@@ -211,12 +211,19 @@ int ast_parking_is_exten_park(const char *context, const char *exten);
* \brief Park the bridge and/or callers that this channel is in * \brief Park the bridge and/or callers that this channel is in
* *
* \param parker The bridge_channel parking the bridge * \param parker The bridge_channel parking the bridge
* \param exten Optional. The extension the channel or bridge was parked at if the * \param[out] exten Optional. The parking exten to access the parking lot.
* call succeeds.
* \param length Optional. If \c exten is specified, the size of the buffer. * \param length Optional. If \c exten is specified, the size of the buffer.
* *
* \note This is safe to be called outside of the \ref AstBridging Bridging API. * \note This is safe to be called outside of the \ref AstBridging Bridging API.
* *
* \note The exten parameter was intended to return the extension the channel or
* bridge was parked at if the call succeeds. However, accessing that information
* is very difficult to do with the new asynchronous design. That information may
* not be available anywhere by the time this function currently returns.
*
* Only, chan_skinny is known to call this function and use the exten parameter
* for the phone display.
*
* \retval 0 on success * \retval 0 on success
* \retval non-zero on error * \retval non-zero on error
*/ */