Skip to content
Snippets Groups Projects
Commit ade5275a authored by Richard Mudgett's avatar Richard Mudgett
Browse files

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

ASTERISK-26029

Change-Id: I2db14d102a48d3224010e6d1c69e856373cc1260
parent 40cb0320
No related branches found
No related tags found
No related merge requests found
......@@ -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
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment