diff options
author | Lee Jones <lee.jones@linaro.org> | 2020-08-19 08:23:41 +0100 |
---|---|---|
committer | Kalle Valo <kvalo@codeaurora.org> | 2020-09-01 12:02:39 +0300 |
commit | 9554663b8c57553af2899f9e28d2d685ca8864db (patch) | |
tree | 2987d22ee8c3b2ee2845b1e9b7d627d6c70c6141 | |
parent | 25ced81e288d2def9f6e6f10e1c88870be8d3121 (diff) |
libertas_tf: Fix a bunch of function doc formatting issues
Kerneldoc expects attributes/parameters to be in '@*.: ' format and
gets confused if the variable does not follow the type/attribute
definitions.
Also demote one stray non-kernel-doc header.
Fixes the following W=1 kernel build warning(s):
drivers/net/wireless/marvell/libertas_tf/cmd.c:44: warning: Function parameter or member 'priv' not described in 'lbtf_cmd_copyback'
drivers/net/wireless/marvell/libertas_tf/cmd.c:44: warning: Function parameter or member 'extra' not described in 'lbtf_cmd_copyback'
drivers/net/wireless/marvell/libertas_tf/cmd.c:44: warning: Function parameter or member 'resp' not described in 'lbtf_cmd_copyback'
drivers/net/wireless/marvell/libertas_tf/cmd.c:80: warning: Function parameter or member 'priv' not described in 'lbtf_update_hw_spec'
drivers/net/wireless/marvell/libertas_tf/cmd.c:150: warning: Function parameter or member 'priv' not described in 'lbtf_set_channel'
drivers/net/wireless/marvell/libertas_tf/cmd.c:150: warning: Function parameter or member 'channel' not described in 'lbtf_set_channel'
drivers/net/wireless/marvell/libertas_tf/cmd.c:277: warning: Function parameter or member 'priv' not described in '__lbtf_cleanup_and_insert_cmd'
drivers/net/wireless/marvell/libertas_tf/cmd.c:277: warning: Function parameter or member 'cmdnode' not described in '__lbtf_cleanup_and_insert_cmd'
drivers/net/wireless/marvell/libertas_tf/cmd.c:442: warning: Function parameter or member 'priv' not described in 'lbtf_allocate_cmd_buffer'
drivers/net/wireless/marvell/libertas_tf/cmd.c:490: warning: Function parameter or member 'priv' not described in 'lbtf_free_cmd_buffer'
drivers/net/wireless/marvell/libertas_tf/cmd.c:527: warning: Function parameter or member 'priv' not described in 'lbtf_get_cmd_ctrl_node'
drivers/net/wireless/marvell/libertas_tf/cmd.c:561: warning: Function parameter or member 'priv' not described in 'lbtf_execute_next_command'
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20200819072402.3085022-8-lee.jones@linaro.org
-rw-r--r-- | drivers/net/wireless/marvell/libertas_tf/cmd.c | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/drivers/net/wireless/marvell/libertas_tf/cmd.c b/drivers/net/wireless/marvell/libertas_tf/cmd.c index a0b4c9debc11..efb98304555a 100644 --- a/drivers/net/wireless/marvell/libertas_tf/cmd.c +++ b/drivers/net/wireless/marvell/libertas_tf/cmd.c @@ -32,10 +32,10 @@ static struct cmd_ctrl_node *lbtf_get_cmd_ctrl_node(struct lbtf_private *priv); /** * lbtf_cmd_copyback - Simple callback that copies response back into command * - * @priv A pointer to struct lbtf_private structure - * @extra A pointer to the original command structure for which + * @priv: A pointer to struct lbtf_private structure + * @extra: A pointer to the original command structure for which * 'resp' is a response - * @resp A pointer to the command response + * @resp: A pointer to the command response * * Returns: 0 on success, error on failure */ @@ -72,7 +72,7 @@ static void lbtf_geo_init(struct lbtf_private *priv) /** * lbtf_update_hw_spec: Updates the hardware details. * - * @priv A pointer to struct lbtf_private structure + * @priv: A pointer to struct lbtf_private structure * * Returns: 0 on success, error on failure */ @@ -141,8 +141,8 @@ out: /** * lbtf_set_channel: Set the radio channel * - * @priv A pointer to struct lbtf_private structure - * @channel The desired channel, or 0 to clear a locked channel + * @priv: A pointer to struct lbtf_private structure + * @channel: The desired channel, or 0 to clear a locked channel * * Returns: 0 on success, error on failure */ @@ -268,7 +268,7 @@ static void lbtf_submit_command(struct lbtf_private *priv, lbtf_deb_leave(LBTF_DEB_HOST); } -/** +/* * This function inserts command node to cmdfreeq * after cleans it. Requires priv->driver_lock held. */ @@ -434,7 +434,7 @@ void lbtf_set_mac_control(struct lbtf_private *priv) /** * lbtf_allocate_cmd_buffer - Allocates cmd buffer, links it to free cmd queue * - * @priv A pointer to struct lbtf_private structure + * @priv: A pointer to struct lbtf_private structure * * Returns: 0 on success. */ @@ -482,7 +482,7 @@ done: /** * lbtf_free_cmd_buffer - Frees the cmd buffer. * - * @priv A pointer to struct lbtf_private structure + * @priv: A pointer to struct lbtf_private structure * * Returns: 0 */ @@ -519,7 +519,7 @@ done: /** * lbtf_get_cmd_ctrl_node - Gets free cmd node from free cmd queue. * - * @priv A pointer to struct lbtf_private structure + * @priv: A pointer to struct lbtf_private structure * * Returns: pointer to a struct cmd_ctrl_node or NULL if none available. */ @@ -553,7 +553,7 @@ static struct cmd_ctrl_node *lbtf_get_cmd_ctrl_node(struct lbtf_private *priv) /** * lbtf_execute_next_command: execute next command in cmd pending queue. * - * @priv A pointer to struct lbtf_private structure + * @priv: A pointer to struct lbtf_private structure * * Returns: 0 on success. */ |