<p>Friendly Automation <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/17525">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Kevin Harwell: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved
Friendly Automation: Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">parking: Fix for Doxygen.<br><br>ASTERISK-29753<br><br>Change-Id: I7a61974584f6169502e6860fc711919fe7bbfaa7<br>---<br>M include/asterisk/parking.h<br>M res/parking/parking_applications.c<br>M res/parking/parking_bridge.c<br>M res/parking/parking_bridge_features.c<br>M res/parking/res_parking.h<br>M res/res_parking.c<br>6 files changed, 29 insertions(+), 41 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/asterisk/parking.h b/include/asterisk/parking.h</span><br><span>index 512b1da..9f5d280 100644</span><br><span>--- a/include/asterisk/parking.h</span><br><span>+++ b/include/asterisk/parking.h</span><br><span>@@ -85,7 +85,7 @@</span><br><span> * \param duration how long the parked call has currently been parked</span><br><span> *</span><br><span> * \retval NULL if the parked call payload can't be allocated</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval reference to a newly created parked call payload</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return reference to a newly created parked call payload</span><br><span> */</span><br><span> struct ast_parked_call_payload *ast_parked_call_payload_create(enum ast_parked_call_event_type event_type,</span><br><span> struct ast_channel_snapshot *parkee_snapshot, const char *parker_dial_string,</span><br><span>@@ -101,7 +101,7 @@</span><br><span> * \since 12</span><br><span> *</span><br><span> * \retval NULL if the parking topic hasn't been created or has been disabled</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval a pointer to the parking topic</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return a pointer to the parking topic</span><br><span> */</span><br><span> struct stasis_topic *ast_parking_topic(void);</span><br><span> </span><br><span>@@ -110,7 +110,7 @@</span><br><span> * \since 12</span><br><span> *</span><br><span> * \retval NULL if the parking topic hasn't been created or has been canceled</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval a pointer to the parked call message type</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return a pointer to the parked call message type</span><br><span> */</span><br><span> struct stasis_message_type *ast_parked_call_type(void);</span><br><span> </span><br><span>@@ -149,7 +149,7 @@</span><br><span> /*!</span><br><span> * \brief Park the bridge and/or callers that this channel is in</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param parker The bridge_channel parking the bridge</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param parker The \p bridge_channel parking the bridge</span><br><span> * \param exten Optional. The extension the channel or bridge was parked at if the</span><br><span> * call succeeds.</span><br><span> * \param length Optional. If \c exten is specified, the size of the buffer.</span><br><span>@@ -164,13 +164,13 @@</span><br><span> /*!</span><br><span> * \brief Perform a blind transfer to a parking extension.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param parker The \ref bridge_channel object that is initiating the parking</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param parker The \p bridge_channel object that is initiating the parking</span><br><span> * \param context The context to blind transfer to</span><br><span> * \param exten The extension to blind transfer to</span><br><span> * \param parked_channel_cb Execute the following function on the channel that gets parked</span><br><span> * \param parked_channel_data Data for the parked_channel_cb</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \note If the bridge \ref parker is in has more than one other occupant, the entire</span><br><span style="color: hsl(120, 100%, 40%);">+ * \note If the bridge \p parker is in has more than one other occupant, the entire</span><br><span> * bridge will be parked using a Local channel</span><br><span> *</span><br><span> * \note This is safe to be called outside of the \ref AstBridging Bridging API.</span><br><span>@@ -235,14 +235,13 @@</span><br><span> /*!</span><br><span> * \brief Perform a blind transfer to a parking extension.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param parker The \ref bridge_channel object that is initiating the parking</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param parker The ast_bridge_channel object that is initiating the parking</span><br><span> * \param context The context to blind transfer to</span><br><span> * \param exten The extension to blind transfer to</span><br><span style="color: hsl(0, 100%, 40%);">- * \param exten The extension to blind transfer to</span><br><span> * \param parked_channel_cb Execute the following function on the channel that gets parked</span><br><span> * \param parked_channel_data Data for the parked_channel_cb</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \note If the bridge \ref parker is in has more than one other occupant, the entire</span><br><span style="color: hsl(120, 100%, 40%);">+ * \note If the bridge \p parker is in has more than one other occupant, the entire</span><br><span> * bridge will be parked using a Local channel</span><br><span> *</span><br><span> * \note This is safe to be called outside of the \ref AstBridging Bridging API.</span><br><span>@@ -283,7 +282,7 @@</span><br><span> /*!</span><br><span> * \brief Unregister the current parking provider</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param The module name of the provider to unregister</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param module_name The module name of the provider to unregister</span><br><span> *</span><br><span> * \retval 0 if the parking provider \c module_name was unregsistered</span><br><span> * \retval -1 on error</span><br><span>diff --git a/res/parking/parking_applications.c b/res/parking/parking_applications.c</span><br><span>index 46dbedf..17ac4eb 100644</span><br><span>--- a/res/parking/parking_applications.c</span><br><span>+++ b/res/parking/parking_applications.c</span><br><span>@@ -740,8 +740,6 @@</span><br><span> *</span><br><span> * \param oh outgoing helper struct we are bestowing inheritable variables to</span><br><span> * \param channel_id name or uniqueID of the channel to inherit variables from</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span> */</span><br><span> static void inherit_channel_vars_from_id(struct outgoing_helper *oh, const char *channel_id)</span><br><span> {</span><br><span>diff --git a/res/parking/parking_bridge.c b/res/parking/parking_bridge.c</span><br><span>index 0a46d79..ba1ea7d 100644</span><br><span>--- a/res/parking/parking_bridge.c</span><br><span>+++ b/res/parking/parking_bridge.c</span><br><span>@@ -48,8 +48,6 @@</span><br><span> * \param self Bridge to operate upon.</span><br><span> *</span><br><span> * \note XXX Stub... and it might go unused.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span> */</span><br><span> static void bridge_parking_destroy(struct ast_bridge_parking *self)</span><br><span> {</span><br><span>@@ -92,7 +90,7 @@</span><br><span> * \brief Construct a parked_user struct assigned to the specified parking lot</span><br><span> *</span><br><span> * \param lot The parking lot we are assigning the user to</span><br><span style="color: hsl(0, 100%, 40%);">- * \param parkee The channel being parked</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param chan The channel being parked</span><br><span> * \param parker_channel_name The name of the parker of this channel</span><br><span> * \param parker_dial_string Takes priority over parker for setting the parker dial string if included</span><br><span> * \param use_random_space if true, prioritize using a random parking space instead</span><br><span>@@ -102,7 +100,7 @@</span><br><span> * use the parking lot limit instead.</span><br><span> *</span><br><span> * \retval NULL on failure</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval reference to the parked user</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return reference to the parked user</span><br><span> *</span><br><span> * \note ao2_cleanup this reference when you are done using it or you'll cause leaks.</span><br><span> */</span><br><span>@@ -336,8 +334,6 @@</span><br><span> * \param bridge_channel Bridge channel to pull.</span><br><span> *</span><br><span> * \note On entry, self is already locked.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span> */</span><br><span> static void bridge_parking_pull(struct ast_bridge_parking *self, struct ast_bridge_channel *bridge_channel)</span><br><span> {</span><br><span>@@ -412,8 +408,6 @@</span><br><span> *</span><br><span> * \note On entry, self is already locked.</span><br><span> * \note XXX Stub... and it will probably go unused.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span> */</span><br><span> static void bridge_parking_notify_masquerade(struct ast_bridge_parking *self, struct ast_bridge_channel *bridge_channel)</span><br><span> {</span><br><span>diff --git a/res/parking/parking_bridge_features.c b/res/parking/parking_bridge_features.c</span><br><span>index 6863d52..5c3f498 100644</span><br><span>--- a/res/parking/parking_bridge_features.c</span><br><span>+++ b/res/parking/parking_bridge_features.c</span><br><span>@@ -320,7 +320,7 @@</span><br><span> * \brief Perform a blind transfer to a parking lot</span><br><span> *</span><br><span> * In general, most parking features should work to call this function. This will safely</span><br><span style="color: hsl(0, 100%, 40%);">- * park either a channel in the bridge with \ref bridge_channel or will park the entire</span><br><span style="color: hsl(120, 100%, 40%);">+ * park either a channel in the bridge with \p bridge_channel or will park the entire</span><br><span> * bridge if more than one channel is in the bridge. It will create the correct data to</span><br><span> * pass to the \ref AstBridging Bridging API to safely park the channel.</span><br><span> *</span><br><span>@@ -490,7 +490,7 @@</span><br><span> * \param length Optional. If \c exten is specified, the length of the buffer.</span><br><span> *</span><br><span> * \note This will determine the context and extension to park the channel based on</span><br><span style="color: hsl(0, 100%, 40%);">- * the configuration of the \ref ast_channel associated with \ref parker. It will then</span><br><span style="color: hsl(120, 100%, 40%);">+ * the configuration of the \ref ast_channel associated with \p parker. It will then</span><br><span> * park either the channel or the entire bridge.</span><br><span> *</span><br><span> * \retval 0 on success</span><br><span>@@ -536,8 +536,6 @@</span><br><span> *</span><br><span> * \param chan Parked channel leaving the parking lot.</span><br><span> * \param cfg Parking lot configuration.</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span> */</span><br><span> static void parking_timeout_set_caller_features(struct ast_channel *chan, struct parking_lot_cfg *cfg)</span><br><span> {</span><br><span>diff --git a/res/parking/res_parking.h b/res/parking/res_parking.h</span><br><span>index cd0b79f..2c025af 100644</span><br><span>--- a/res/parking/res_parking.h</span><br><span>+++ b/res/parking/res_parking.h</span><br><span>@@ -137,7 +137,7 @@</span><br><span> * \param cfg The configuration being used as a reference to build the parking lot from.</span><br><span> * \param dynamic non-zero if creating a dynamic parking lot with this. Don't replace existing parking lots. Ever.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval A reference to the new parking lot</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return A reference to the new parking lot</span><br><span> * \retval NULL if it was not found and could not be allocated</span><br><span> *</span><br><span> * \note The parking lot will need to be unreffed if it ever falls out of scope</span><br><span>@@ -166,7 +166,7 @@</span><br><span> * \param bridge_lot Parking lot which the new bridge should be based on</span><br><span> *</span><br><span> * \retval NULL if the bridge can not be created</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval Newly created parking bridge</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return Newly created parking bridge</span><br><span> */</span><br><span> struct ast_bridge *bridge_parking_new(struct parking_lot *bridge_lot);</span><br><span> </span><br><span>@@ -176,7 +176,7 @@</span><br><span> *</span><br><span> * \param lot Which parking lot we need the bridge from. This parking lot must be locked before calling this function.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval A reference to the ast_bridge associated with the parking lot</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return A reference to the ast_bridge associated with the parking lot</span><br><span> * \retval NULL if it didn't already have a bridge and one couldn't be created</span><br><span> *</span><br><span> * \note This bridge will need to be unreffed if it ever falls out of scope.</span><br><span>@@ -191,7 +191,7 @@</span><br><span> * \param target_override If there is a specific slot we want, provide it here and we'll start from that position</span><br><span> *</span><br><span> * \retval -1 if No slot can be found</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval integer value of parking space selected</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return integer value of parking space selected</span><br><span> *</span><br><span> * \note lot should be locked before this is called and unlocked only after a parked_user with the space</span><br><span> * returned has been added to the parking lot.</span><br><span>@@ -206,7 +206,7 @@</span><br><span> * If >= 0 Only pull from the indicated target</span><br><span> *</span><br><span> * \retval NULL if no parked user could be pulled from the requested parking lot at the requested parking space</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval reference to the requested parked user</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return reference to the requested parked user</span><br><span> *</span><br><span> */</span><br><span> struct parked_user *parking_lot_inspect_parked_user(struct parking_lot *lot, int target);</span><br><span>@@ -220,7 +220,7 @@</span><br><span> * If >= 0 Only pull from the indicated target</span><br><span> *</span><br><span> * \retval NULL if no parked user could be pulled from the requested parking lot at the requested parking space</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval reference to the requested parked user</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return reference to the requested parked user</span><br><span> *</span><br><span> * \note The parked user will be removed from parking lot as part of this process</span><br><span> * \note Remove this reference with ao2_cleanup once it falls out of scope.</span><br><span>@@ -271,7 +271,7 @@</span><br><span> * \since 12.0.0</span><br><span> * \brief Get a pointer to the parking lot container for purposes such as iteration</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval pointer to the parking lot container.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return pointer to the parking lot container.</span><br><span> */</span><br><span> struct ao2_container *get_parking_lot_container(void);</span><br><span> </span><br><span>@@ -281,7 +281,7 @@</span><br><span> *</span><br><span> * \param lot_name Name of the parking lot sought</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval The parking lot if found</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return The parking lot if found</span><br><span> * \retval NULL if no parking lot with the name specified exists</span><br><span> *</span><br><span> * \note ao2_cleanup this reference when you are done using it or you'll cause leaks.</span><br><span>@@ -295,7 +295,7 @@</span><br><span> * \param name Dynamic parking lot name to create</span><br><span> * \param chan Channel parkee to get dynamic parking lot parameters from</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval dynamically created parking lot on success</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return dynamically created parking lot on success</span><br><span> * \retval NULL on error</span><br><span> *</span><br><span> * \note This should be called only after verifying that the named parking lot doesn't already exist in a non-dynamic way.</span><br><span>@@ -310,7 +310,7 @@</span><br><span> * \param name Dynamic parking lot name to create</span><br><span> * \param chan Channel parkee to get the dynamic parking lot parameters from</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval dynamically created parking lot on success</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return dynamically created parking lot on success</span><br><span> * \retval NULL on error</span><br><span> *</span><br><span> * \note This should be called only after verifying that the named parking lot doesn't already exist in a non-dynamic way.</span><br><span>@@ -336,7 +336,7 @@</span><br><span> * \since 12.0.0</span><br><span> * \brief Flattens a dial string so that it can be written to/found from PBX extensions</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param peername unflattened dial string. This will be flattened in place.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param dialstring unflattened dial string. This will be flattened in place.</span><br><span> */</span><br><span> void flatten_dial_string(char *dialstring);</span><br><span> </span><br><span>@@ -437,7 +437,7 @@</span><br><span> * \param silence_announcements optional pointer to an integer where we want to store the silence option flag</span><br><span> * this value should be initialized to 0 prior to calling park_common_setup.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval reference to a parking bridge if successful</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return reference to a parking bridge if successful</span><br><span> * \retval NULL on failure</span><br><span> *</span><br><span> * \note ao2_cleanup this reference when you are done using it or you'll cause leaks.</span><br><span>@@ -460,7 +460,7 @@</span><br><span> *</span><br><span> * \param parkee The channel entering parking with the datastore we are checking</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval Pointer to a copy of the park common datastore for parkee if it could be cloned. This needs to be free'd with park_common_datastore free.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return Pointer to a copy of the park common datastore for parkee if it could be cloned. This needs to be free'd with park_common_datastore free.</span><br><span> * \retval NULL if the park_common_datastore could not be copied off of the channel.</span><br><span> */</span><br><span> struct park_common_datastore *get_park_common_datastore_copy(struct ast_channel *parkee);</span><br><span>@@ -573,8 +573,6 @@</span><br><span> /*!</span><br><span> * \since 12.0.0</span><br><span> * \brief Unregister parking unit tests</span><br><span style="color: hsl(0, 100%, 40%);">- *</span><br><span style="color: hsl(0, 100%, 40%);">- * \return Nothing</span><br><span> */</span><br><span> void unload_parking_tests(void);</span><br><span> </span><br><span>diff --git a/res/res_parking.c b/res/res_parking.c</span><br><span>index cde82d2..644337d 100644</span><br><span>--- a/res/res_parking.c</span><br><span>+++ b/res/res_parking.c</span><br><span>@@ -489,9 +489,10 @@</span><br><span> * \brief find an item in a container by its name</span><br><span> *</span><br><span> * \param container ao2container where we want the item from</span><br><span style="color: hsl(0, 100%, 40%);">- * \param key name of the item wanted to be found</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param name name of the item wanted to be found</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval pointer to the parking lot if available. NULL if not found.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return pointer to the parking lot if available.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval NULL if not found.</span><br><span> */</span><br><span> static void *named_item_find(struct ao2_container *container, const char *name)</span><br><span> {</span><br><span></span><br></pre><div style="white-space:pre-wrap"></div><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/17525">change 17525</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/17525"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 18 </div>
<div style="display:none"> Gerrit-Change-Id: I7a61974584f6169502e6860fc711919fe7bbfaa7 </div>
<div style="display:none"> Gerrit-Change-Number: 17525 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Alexander Traud <pabstraud@compuserve.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>