[Asterisk-code-review] res_xmpp: Fix for Doxygen. (asterisk[19])
Friendly Automation
asteriskteam at digium.com
Thu Nov 18 12:49:53 CST 2021
Friendly Automation has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/17487 )
Change subject: res_xmpp: Fix for Doxygen.
......................................................................
res_xmpp: Fix for Doxygen.
ASTERISK-29749
Change-Id: I7885793b63bdeaa883e76edb899bbba9660eb1c5
---
M res/res_xmpp.c
1 file changed, 22 insertions(+), 31 deletions(-)
Approvals:
Kevin Harwell: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved
Friendly Automation: Approved for Submit
diff --git a/res/res_xmpp.c b/res/res_xmpp.c
index ebf128d..8db0da8 100644
--- a/res/res_xmpp.c
+++ b/res/res_xmpp.c
@@ -31,7 +31,7 @@
*
*/
-/*! \li \ref res_xmpp.c uses the configuration file \ref xmpp.conf and \ref jabber.conf
+/*! \li \ref res_xmpp.c uses the configuration file \ref xmpp.conf
* \addtogroup configuration_file Configuration Files
*/
@@ -1034,7 +1034,7 @@
* \brief Create an IQ packet
* \param client the configured XMPP client we use to connect to a XMPP server
* \param type the type of IQ packet to create
- * \return iks*
+ * \return iks *
*/
static iks* xmpp_pubsub_iq_create(struct ast_xmpp_client *client, const char *type)
{
@@ -1065,7 +1065,7 @@
* \brief Build the skeleton of a publish
* \param client the configured XMPP client we use to connect to a XMPP server
* \param node Name of the node that will be published to
- * \param event_type
+ * \param event_type, cachable
* \return iks *
*/
static iks* xmpp_pubsub_build_publish_skeleton(struct ast_xmpp_client *client, const char *node,
@@ -1151,7 +1151,6 @@
* \brief Add Owner affiliations for pubsub node
* \param client the configured XMPP client we use to connect to a XMPP server
* \param node the name of the node to which to add affiliations
- * \return void
*/
static void xmpp_pubsub_create_affiliations(struct ast_xmpp_client *client, const char *node)
{
@@ -1189,7 +1188,6 @@
* \param node_type the type of node to create
* \param name the name of the node to create
* \param collection_name
- * \return void
*/
static void xmpp_pubsub_create_node(struct ast_xmpp_client *client, const char *node_type, const
char *name, const char *collection_name)
@@ -1237,7 +1235,6 @@
* \brief Create a PubSub collection node.
* \param client the configured XMPP client we use to connect to a XMPP server
* \param collection_name The name to use for this collection
- * \return void.
*/
static void xmpp_pubsub_create_collection(struct ast_xmpp_client *client, const char *collection_name)
{
@@ -1250,7 +1247,6 @@
* \param client the configured XMPP client we use to connect to a XMPP server
* \param collection_name
* \param leaf_name The name to use for this collection
- * \return void.
*/
static void xmpp_pubsub_create_leaf(struct ast_xmpp_client *client, const char *collection_name,
const char *leaf_name)
@@ -1264,7 +1260,6 @@
* \param mailbox The mailbox identifier
* \param oldmsgs Old messages
* \param newmsgs New Messages
- * \return void
*/
static void xmpp_pubsub_publish_mwi(struct ast_xmpp_client *client, const char *mailbox,
const char *oldmsgs, const char *newmsgs)
@@ -1295,7 +1290,7 @@
* \param client the configured XMPP client we use to connect to a XMPP server
* \param device the name of the device whose state to publish
* \param device_state the state to publish
- * \return void
+ * \param cachable
*/
static void xmpp_pubsub_publish_device_state(struct ast_xmpp_client *client, const char *device,
const char *device_state, unsigned int cachable)
@@ -1329,9 +1324,8 @@
/*!
* \brief Callback function for MWI events
- * \param ast_event
* \param data void pointer to ast_client structure
- * \return void
+ * \param sub, msg
*/
static void xmpp_pubsub_mwi_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)
{
@@ -1357,9 +1351,8 @@
/*!
* \brief Callback function for device state events
- * \param ast_event
* \param data void pointer to ast_client structure
- * \return void
+ * \param sub, msg
*/
static void xmpp_pubsub_devstate_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)
{
@@ -1383,7 +1376,6 @@
* \brief Unsubscribe from a PubSub node
* \param client the configured XMPP client we use to connect to a XMPP server
* \param node the name of the node to which to unsubscribe from
- * \return void
*/
static void xmpp_pubsub_unsubscribe(struct ast_xmpp_client *client, const char *node)
{
@@ -1409,7 +1401,6 @@
* \brief Subscribe to a PubSub node
* \param client the configured XMPP client we use to connect to a XMPP server
* \param node the name of the node to which to subscribe
- * \return void
*/
static void xmpp_pubsub_subscribe(struct ast_xmpp_client *client, const char *node)
{
@@ -1456,7 +1447,7 @@
* \brief Callback for handling PubSub events
* \param data void pointer to ast_xmpp_client structure
* \param pak A pak
- * \return IKS_FILTER_EAT
+ * \retval IKS_FILTER_EAT
*/
static int xmpp_pubsub_handle_event(void *data, ikspak *pak)
{
@@ -1583,7 +1574,6 @@
/*!
* \brief Initialize collections for event distribution
* \param client the configured XMPP client we use to connect to a XMPP server
- * \return void
*/
static void xmpp_init_event_distribution(struct ast_xmpp_client *client)
{
@@ -1661,9 +1651,10 @@
/*!
* \internal
* \brief Dial plan funtcion to retrieve the status of a buddy.
- * \param channel The associated ast_channel, if there is one
+ * \param chan The associated ast_channel, if there is one
* \param data The account, buddy JID, and optional timeout
- * timeout.
+ * \param name, buf, buflen
+ *
* \retval 0 success
* \retval -1 failure
*/
@@ -1927,9 +1918,10 @@
/*!
* \internal
* \brief Dial plan function to receive a message.
- * \param channel The associated ast_channel, if there is one
+ * \param chan The associated ast_channel, if there is one
* \param data The account, JID, and optional timeout
- * timeout.
+ * \param name, buf, buflen
+ *
* \retval 0 success
* \retval -1 failure
*/
@@ -3922,7 +3914,7 @@
* \brief Send a Jabber Message via call from the Manager
* \param s mansession Manager session
* \param m message Message to send
- * \return 0
+ * \retval 0
*/
static int manager_jabber_send(struct mansession *s, const struct message *m)
{
@@ -3972,7 +3964,7 @@
* \brief Build the a node request
* \param client the configured XMPP client we use to connect to a XMPP server
* \param collection name of the collection for request
- * \return iks*
+ * \return iks *
*/
static iks* xmpp_pubsub_build_node_request(struct ast_xmpp_client *client, const char *collection)
{
@@ -3996,7 +3988,7 @@
* \brief Receive pubsub item lists
* \param data pointer to ast_xmpp_client structure
* \param pak response from pubsub diso#items query
- * \return IKS_FILTER_EAT
+ * \retval IKS_FILTER_EAT
*/
static int xmpp_pubsub_receive_node_list(void *data, ikspak* pak)
{
@@ -4024,7 +4016,6 @@
* \brief Request item list from pubsub
* \param client the configured XMPP client we use to connect to a XMPP server
* \param collection name of the collection for request
-* \return void
*/
static void xmpp_pubsub_request_nodes(struct ast_xmpp_client *client, const char *collection)
{
@@ -4095,7 +4086,7 @@
* \brief Delete pubsub item lists
* \param data pointer to ast_xmpp_client structure
* \param pak response from pubsub diso#items query
- * \return IKS_FILTER_EAT
+ * \retval IKS_FILTER_EAT
*/
static int xmpp_pubsub_delete_node_list(void *data, ikspak* pak)
{
@@ -4217,7 +4208,7 @@
/*!
* \brief Method to expose PubSub collection node creation via CLI.
- * \return char *.
+ * \return char *
*/
static char *xmpp_cli_create_collection(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
@@ -4257,7 +4248,7 @@
/*!
* \brief Method to expose PubSub leaf node creation via CLI.
- * \return char *.
+ * \return char *
*/
static char *xmpp_cli_create_leafnode(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
@@ -4299,7 +4290,7 @@
/*!
* \internal
* \brief Turn on/off console debugging.
- * \return CLI_SUCCESS.
+ * \retval CLI_SUCCESS
*/
static char *xmpp_do_set_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
@@ -4333,7 +4324,7 @@
/*!
* \internal
* \brief Show client status.
- * \return CLI_SUCCESS.
+ * \retval CLI_SUCCESS
*/
static char *xmpp_show_clients(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
@@ -4409,7 +4400,7 @@
/*!
* \internal
* \brief Show buddy lists
- * \return CLI_SUCCESS.
+ * \retval CLI_SUCCESS
*/
static char *xmpp_show_buddies(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
--
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17487
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings
Gerrit-Project: asterisk
Gerrit-Branch: 19
Gerrit-Change-Id: I7885793b63bdeaa883e76edb899bbba9660eb1c5
Gerrit-Change-Number: 17487
Gerrit-PatchSet: 2
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211118/c2d45219/attachment-0001.html>
More information about the asterisk-code-review
mailing list