diff options
| author | Joshua Colp <jcolp@digium.com> | 2016-05-23 06:15:59 -0500 |
|---|---|---|
| committer | Gerrit Code Review <gerrit2@gerrit.digium.api> | 2016-05-23 06:15:59 -0500 |
| commit | 0eb293d2c4a36cc4d48d2fcce278cf8737c1165b (patch) | |
| tree | 76984b5c6359e946ef054856a2bf0ebc3e2c1d9b | |
| parent | 1c02b19b79019c7438e162d4db83a5fbf6c46554 (diff) | |
| parent | ade5275a3e1b0dac1d00936e92f93d957384fe8b (diff) | |
Merge "parking.h: Update ast_parking_park_call() doxygen to reality."
| -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 4c93c3b45..53dfe9320 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 */ |