<p>Kevin Harwell <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/17489">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Kevin Harwell: Looks good to me, but someone else must approve; Approved for Submit
George Joseph: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">res_xmpp: Fix for Doxygen.<br><br>ASTERISK-29749<br><br>Change-Id: I7885793b63bdeaa883e76edb899bbba9660eb1c5<br>---<br>M res/res_xmpp.c<br>1 file changed, 22 insertions(+), 31 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/res/res_xmpp.c b/res/res_xmpp.c</span><br><span>index e04d9f0..69a7770 100644</span><br><span>--- a/res/res_xmpp.c</span><br><span>+++ b/res/res_xmpp.c</span><br><span>@@ -31,7 +31,7 @@</span><br><span> *</span><br><span> */</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \li \ref res_xmpp.c uses the configuration file \ref xmpp.conf and \ref jabber.conf</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \li \ref res_xmpp.c uses the configuration file \ref xmpp.conf</span><br><span> * \addtogroup configuration_file Configuration Files</span><br><span> */</span><br><span> </span><br><span>@@ -1061,7 +1061,7 @@</span><br><span> * \brief Create an IQ packet</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param type the type of IQ packet to create</span><br><span style="color: hsl(0, 100%, 40%);">- * \return iks*</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return iks *</span><br><span> */</span><br><span> static iks* xmpp_pubsub_iq_create(struct ast_xmpp_client *client, const char *type)</span><br><span> {</span><br><span>@@ -1092,7 +1092,7 @@</span><br><span> * \brief Build the skeleton of a publish</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param node Name of the node that will be published to</span><br><span style="color: hsl(0, 100%, 40%);">- * \param event_type</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param event_type, cachable</span><br><span> * \return iks *</span><br><span> */</span><br><span> static iks* xmpp_pubsub_build_publish_skeleton(struct ast_xmpp_client *client, const char *node,</span><br><span>@@ -1178,7 +1178,6 @@</span><br><span> * \brief Add Owner affiliations for pubsub node</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param node the name of the node to which to add affiliations</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span> */</span><br><span> static void xmpp_pubsub_create_affiliations(struct ast_xmpp_client *client, const char *node)</span><br><span> {</span><br><span>@@ -1216,7 +1215,6 @@</span><br><span> * \param node_type the type of node to create</span><br><span> * \param name the name of the node to create</span><br><span> * \param collection_name</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span> */</span><br><span> static void xmpp_pubsub_create_node(struct ast_xmpp_client *client, const char *node_type, const</span><br><span> char *name, const char *collection_name)</span><br><span>@@ -1264,7 +1262,6 @@</span><br><span> * \brief Create a PubSub collection node.</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param collection_name The name to use for this collection</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void.</span><br><span> */</span><br><span> static void xmpp_pubsub_create_collection(struct ast_xmpp_client *client, const char *collection_name)</span><br><span> {</span><br><span>@@ -1277,7 +1274,6 @@</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param collection_name</span><br><span> * \param leaf_name The name to use for this collection</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void.</span><br><span> */</span><br><span> static void xmpp_pubsub_create_leaf(struct ast_xmpp_client *client, const char *collection_name,</span><br><span> const char *leaf_name)</span><br><span>@@ -1291,7 +1287,6 @@</span><br><span> * \param mailbox The mailbox identifier</span><br><span> * \param oldmsgs Old messages</span><br><span> * \param newmsgs New Messages</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span> */</span><br><span> static void xmpp_pubsub_publish_mwi(struct ast_xmpp_client *client, const char *mailbox,</span><br><span> const char *oldmsgs, const char *newmsgs)</span><br><span>@@ -1322,7 +1317,7 @@</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param device the name of the device whose state to publish</span><br><span> * \param device_state the state to publish</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param cachable</span><br><span> */</span><br><span> static void xmpp_pubsub_publish_device_state(struct ast_xmpp_client *client, const char *device,</span><br><span> const char *device_state, unsigned int cachable)</span><br><span>@@ -1356,9 +1351,8 @@</span><br><span> </span><br><span> /*!</span><br><span> * \brief Callback function for MWI events</span><br><span style="color: hsl(0, 100%, 40%);">- * \param ast_event</span><br><span> * \param data void pointer to ast_client structure</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param sub, msg</span><br><span> */</span><br><span> static void xmpp_pubsub_mwi_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)</span><br><span> {</span><br><span>@@ -1384,9 +1378,8 @@</span><br><span> </span><br><span> /*!</span><br><span> * \brief Callback function for device state events</span><br><span style="color: hsl(0, 100%, 40%);">- * \param ast_event</span><br><span> * \param data void pointer to ast_client structure</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param sub, msg</span><br><span> */</span><br><span> static void xmpp_pubsub_devstate_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)</span><br><span> {</span><br><span>@@ -1410,7 +1403,6 @@</span><br><span> * \brief Unsubscribe from a PubSub node</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param node the name of the node to which to unsubscribe from</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span> */</span><br><span> static void xmpp_pubsub_unsubscribe(struct ast_xmpp_client *client, const char *node)</span><br><span> {</span><br><span>@@ -1436,7 +1428,6 @@</span><br><span> * \brief Subscribe to a PubSub node</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param node the name of the node to which to subscribe</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span> */</span><br><span> static void xmpp_pubsub_subscribe(struct ast_xmpp_client *client, const char *node)</span><br><span> {</span><br><span>@@ -1483,7 +1474,7 @@</span><br><span> * \brief Callback for handling PubSub events</span><br><span> * \param data void pointer to ast_xmpp_client structure</span><br><span> * \param pak A pak</span><br><span style="color: hsl(0, 100%, 40%);">- * \return IKS_FILTER_EAT</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval IKS_FILTER_EAT</span><br><span> */</span><br><span> static int xmpp_pubsub_handle_event(void *data, ikspak *pak)</span><br><span> {</span><br><span>@@ -1610,7 +1601,6 @@</span><br><span> /*!</span><br><span> * \brief Initialize collections for event distribution</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span style="color: hsl(0, 100%, 40%);">- * \return void</span><br><span> */</span><br><span> static void xmpp_init_event_distribution(struct ast_xmpp_client *client)</span><br><span> {</span><br><span>@@ -1746,9 +1736,10 @@</span><br><span> /*!</span><br><span> * \internal</span><br><span> * \brief Dial plan funtcion to retrieve the status of a buddy.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param channel The associated ast_channel, if there is one</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param chan The associated ast_channel, if there is one</span><br><span> * \param data The account, buddy JID, and optional timeout</span><br><span style="color: hsl(0, 100%, 40%);">- * timeout.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param name, buf, buflen</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \retval 0 success</span><br><span> * \retval -1 failure</span><br><span> */</span><br><span>@@ -2012,9 +2003,10 @@</span><br><span> /*!</span><br><span> * \internal</span><br><span> * \brief Dial plan function to receive a message.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param channel The associated ast_channel, if there is one</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param chan The associated ast_channel, if there is one</span><br><span> * \param data The account, JID, and optional timeout</span><br><span style="color: hsl(0, 100%, 40%);">- * timeout.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param name, buf, buflen</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \retval 0 success</span><br><span> * \retval -1 failure</span><br><span> */</span><br><span>@@ -4007,7 +3999,7 @@</span><br><span> * \brief Send a Jabber Message via call from the Manager</span><br><span> * \param s mansession Manager session</span><br><span> * \param m message Message to send</span><br><span style="color: hsl(0, 100%, 40%);">- * \return 0</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0</span><br><span> */</span><br><span> static int manager_jabber_send(struct mansession *s, const struct message *m)</span><br><span> {</span><br><span>@@ -4057,7 +4049,7 @@</span><br><span> * \brief Build the a node request</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param collection name of the collection for request</span><br><span style="color: hsl(0, 100%, 40%);">- * \return iks*</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return iks *</span><br><span> */</span><br><span> static iks* xmpp_pubsub_build_node_request(struct ast_xmpp_client *client, const char *collection)</span><br><span> {</span><br><span>@@ -4081,7 +4073,7 @@</span><br><span> * \brief Receive pubsub item lists</span><br><span> * \param data pointer to ast_xmpp_client structure</span><br><span> * \param pak response from pubsub diso#items query</span><br><span style="color: hsl(0, 100%, 40%);">- * \return IKS_FILTER_EAT</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval IKS_FILTER_EAT</span><br><span> */</span><br><span> static int xmpp_pubsub_receive_node_list(void *data, ikspak* pak)</span><br><span> {</span><br><span>@@ -4109,7 +4101,6 @@</span><br><span> * \brief Request item list from pubsub</span><br><span> * \param client the configured XMPP client we use to connect to a XMPP server</span><br><span> * \param collection name of the collection for request</span><br><span style="color: hsl(0, 100%, 40%);">-* \return void</span><br><span> */</span><br><span> static void xmpp_pubsub_request_nodes(struct ast_xmpp_client *client, const char *collection)</span><br><span> {</span><br><span>@@ -4180,7 +4171,7 @@</span><br><span> * \brief Delete pubsub item lists</span><br><span> * \param data pointer to ast_xmpp_client structure</span><br><span> * \param pak response from pubsub diso#items query</span><br><span style="color: hsl(0, 100%, 40%);">- * \return IKS_FILTER_EAT</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval IKS_FILTER_EAT</span><br><span> */</span><br><span> static int xmpp_pubsub_delete_node_list(void *data, ikspak* pak)</span><br><span> {</span><br><span>@@ -4302,7 +4293,7 @@</span><br><span> </span><br><span> /*!</span><br><span> * \brief Method to expose PubSub collection node creation via CLI.</span><br><span style="color: hsl(0, 100%, 40%);">- * \return char *.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return char *</span><br><span> */</span><br><span> static char *xmpp_cli_create_collection(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</span><br><span> {</span><br><span>@@ -4342,7 +4333,7 @@</span><br><span> </span><br><span> /*!</span><br><span> * \brief Method to expose PubSub leaf node creation via CLI.</span><br><span style="color: hsl(0, 100%, 40%);">- * \return char *.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return char *</span><br><span> */</span><br><span> static char *xmpp_cli_create_leafnode(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</span><br><span> {</span><br><span>@@ -4384,7 +4375,7 @@</span><br><span> /*!</span><br><span> * \internal</span><br><span> * \brief Turn on/off console debugging.</span><br><span style="color: hsl(0, 100%, 40%);">- * \return CLI_SUCCESS.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval CLI_SUCCESS</span><br><span> */</span><br><span> static char *xmpp_do_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</span><br><span> {</span><br><span>@@ -4418,7 +4409,7 @@</span><br><span> /*!</span><br><span> * \internal</span><br><span> * \brief Show client status.</span><br><span style="color: hsl(0, 100%, 40%);">- * \return CLI_SUCCESS.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval CLI_SUCCESS</span><br><span> */</span><br><span> static char *xmpp_show_clients(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</span><br><span> {</span><br><span>@@ -4494,7 +4485,7 @@</span><br><span> /*!</span><br><span> * \internal</span><br><span> * \brief Show buddy lists</span><br><span style="color: hsl(0, 100%, 40%);">- * \return CLI_SUCCESS.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval CLI_SUCCESS</span><br><span> */</span><br><span> static char *xmpp_show_buddies(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</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/+/17489">change 17489</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/+/17489"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 16 </div>
<div style="display:none"> Gerrit-Change-Id: I7885793b63bdeaa883e76edb899bbba9660eb1c5 </div>
<div style="display:none"> Gerrit-Change-Number: 17489 </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>