sysmocom/asterisk
11
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Joshua Colp 2016-05-23 06:15:59 -05:00 committed by Gerrit Code Review
commit 0eb293d2c4
1 changed files with 9 additions and 2 deletions
Show stats 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
*
* \param parker The bridge_channel parking the bridge
* \param exten Optional. The extension the channel or bridge was parked at if the
* call succeeds.
* \param[out] exten Optional. The parking exten to access the parking lot.
* \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 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 non-zero on error
*/