diff options
| author | Richard Mudgett <rmudgett@digium.com> | 2016-05-20 16:59:52 -0500 |
|---|---|---|
| committer | Richard Mudgett <rmudgett@digium.com> | 2016-05-20 17:55:40 -0500 |
| commit | 9453d1187ab1258166ae2fd8185ffb7b6e2c4575 (patch) | |
| tree | 6fc2819d8d26c4381d5fe336dcde8505cbe6f63c /include | |
| parent | ddcf983e392c6eeeb925109961697992f341e5d5 (diff) | |
parking.h: Update ast_parking_park_call() doxygen to reality.
ASTERISK-26029
Change-Id: I2db14d102a48d3224010e6d1c69e856373cc1260
Diffstat (limited to 'include')
| -rw-r--r-- | include/asterisk/parking.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/include/asterisk/parking.h b/include/asterisk/parking.h index a8832cdb8..1cf750c08 100644 --- a/include/asterisk/parking.h +++ b/include/asterisk/parking.h @@ -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 */ |