[asterisk-commits] parking.h: Update ast parking park call() doxygen to reality. (asterisk[master])

[SVN commits to the Asterisk project]

Joshua Colp has submitted this change and it was merged.

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


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

ASTERISK-26029

Change-Id: I2db14d102a48d3224010e6d1c69e856373cc1260
---
M include/asterisk/parking.h
1 file changed, 9 insertions(+), 2 deletions(-)

Approvals:
  George Joseph: Looks good to me, but someone else must approve
  Joshua Colp: Looks good to me, approved; Verified



diff --git a/include/asterisk/parking.h b/include/asterisk/parking.h
index 4c93c3b..53dfe93 100644
--- a/include/asterisk/parking.h
+++ b/include/asterisk/parking.h
@@ -211,12 +211,19 @@
  * \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
  */

-- 
To view, visit https://gerrit.asterisk.org/2888
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I2db14d102a48d3224010e6d1c69e856373cc1260
Gerrit-PatchSet: 2
Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Owner: Richard Mudgett <rmudgett at digium.com>
Gerrit-Reviewer: Anonymous Coward #1000019
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Joshua Colp <jcolp at digium.com>