[media] staging: as102: Convert the comments to kernel-doc style

Also amend some mismatched comments.

Cc: Devin Heitmueller <dheitmueller@kernellabs.com>
Signed-off-by: Sylwester Nawrocki <snjw23@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

1 files changed, 49 insertions, 56 deletions

diff --git a/drivers/staging/media/as102/as10x_cmd.c b/drivers/staging/media/as102/as10x_cmd.c
index 77aae3964fa2..0dcba8065780 100644
--- a/drivers/staging/media/as102/as10x_cmd.c
+++ b/drivers/staging/media/as102/as10x_cmd.c
@@ -24,11 +24,11 @@
 #include "as10x_cmd.h"
 
 /**
-   \brief  send turn on command to AS10x
-   \param  phandle:   pointer to AS10x handle
-   \return 0 when no error, < 0 in case of error.
-  \callgraph
-*/
+ * as10x_cmd_turn_on - send turn on command to AS10x
+ * @phandle:   pointer to AS10x handle
+ *
+ * Return 0 when no error, < 0 in case of error.
+ */
 int as10x_cmd_turn_on(as10x_handle_t *phandle)
 {
 	int error;
@@ -70,11 +70,11 @@ out:
 }
 
 /**
-   \brief  send turn off command to AS10x
-   \param  phandle:   pointer to AS10x handle
-   \return 0 when no error, < 0 in case of error.
-   \callgraph
-*/
+ * as10x_cmd_turn_off - send turn off command to AS10x
+ * @phandle:   pointer to AS10x handle
+ *
+ * Return 0 on success or negative value in case of error.
+ */
 int as10x_cmd_turn_off(as10x_handle_t *phandle)
 {
 	int error;
@@ -115,11 +115,11 @@ out:
 }
 
 /**
-   \brief  send set tune command to AS10x
-   \param  phandle: pointer to AS10x handle
-   \param  ptune:   tune parameters
-   \return 0 when no error, < 0 in case of error.
-   \callgraph
+ * as10x_cmd_set_tune - send set tune command to AS10x
+ * @phandle: pointer to AS10x handle
+ * @ptune:   tune parameters
+ *
+ * Return 0 on success or negative value in case of error.
  */
 int as10x_cmd_set_tune(as10x_handle_t *phandle, struct as10x_tune_args *ptune)
 {
@@ -174,11 +174,11 @@ out:
 }
 
 /**
-   \brief  send get tune status command to AS10x
-   \param  phandle:   pointer to AS10x handle
-   \param  pstatus:   pointer to updated status structure of the current tune
-   \return 0 when no error, < 0 in case of error.
-   \callgraph
+ * as10x_cmd_get_tune_status - send get tune status command to AS10x
+ * @phandle: pointer to AS10x handle
+ * @pstatus: pointer to updated status structure of the current tune
+ *
+ * Return 0 on success or negative value in case of error.
  */
 int as10x_cmd_get_tune_status(as10x_handle_t *phandle,
 			      struct as10x_tune_status *pstatus)
@@ -232,11 +232,11 @@ out:
 }
 
 /**
-   \brief  send get TPS command to AS10x
-   \param  phandle:   pointer to AS10x handle
-   \param  ptps:      pointer to TPS parameters structure
-   \return 0 when no error, < 0 in case of error.
-   \callgraph
+ * send get TPS command to AS10x
+ * @phandle:   pointer to AS10x handle
+ * @ptps:      pointer to TPS parameters structure
+ *
+ * Return 0 on success or negative value in case of error.
  */
 int as10x_cmd_get_tps(as10x_handle_t *phandle, struct as10x_tps *ptps)
 {
@@ -295,12 +295,12 @@ out:
 }
 
 /**
-   \brief  send get demod stats command to AS10x
-   \param  phandle:       pointer to AS10x handle
-   \param  pdemod_stats:  pointer to demod stats parameters structure
-   \return 0 when no error, < 0 in case of error.
-   \callgraph
-*/
+ * as10x_cmd_get_demod_stats - send get demod stats command to AS10x
+ * @phandle:       pointer to AS10x handle
+ * @pdemod_stats:  pointer to demod stats parameters structure
+ *
+ * Return 0 on success or negative value in case of error.
+ */
 int as10x_cmd_get_demod_stats(as10x_handle_t  *phandle,
 			      struct as10x_demod_stats *pdemod_stats)
 {
@@ -359,13 +359,13 @@ out:
 }
 
 /**
-   \brief  send get impulse response command to AS10x
-   \param  phandle:        pointer to AS10x handle
-   \param  is_ready:       pointer to value indicating when impulse
-			   response data is ready
-   \return 0 when no error, < 0 in case of error.
-   \callgraph
-*/
+ * as10x_cmd_get_impulse_resp - send get impulse response command to AS10x
+ * @phandle:  pointer to AS10x handle
+ * @is_ready: pointer to value indicating when impulse
+ *	      response data is ready
+ *
+ * Return 0 on success or negative value in case of error.
+ */
 int as10x_cmd_get_impulse_resp(as10x_handle_t     *phandle,
 			       uint8_t *is_ready)
 {
@@ -414,16 +414,12 @@ out:
 	return error;
 }
 
-
-
 /**
-   \brief  build AS10x command header
-   \param  pcmd:     pointer to AS10x command buffer
-   \param  xid:      sequence id of the command
-   \param  cmd_len:  lenght of the command
-   \return -
-   \callgraph
-*/
+ * as10x_cmd_build - build AS10x command header
+ * @pcmd:     pointer to AS10x command buffer
+ * @xid:      sequence id of the command
+ * @cmd_len:  length of the command
+ */
 void as10x_cmd_build(struct as10x_cmd_t *pcmd,
 		     uint16_t xid, uint16_t cmd_len)
 {
@@ -434,13 +430,12 @@ void as10x_cmd_build(struct as10x_cmd_t *pcmd,
 }
 
 /**
-   \brief  Parse command response
-   \param  pcmd:       pointer to AS10x command buffer
-   \param  cmd_seqid:  sequence id of the command
-   \param  cmd_len:    lenght of the command
-   \return 0 when no error, < 0 in case of error
-   \callgraph
-*/
+ * as10x_rsp_parse - Parse command response
+ * @prsp:       pointer to AS10x command buffer
+ * @proc_id:    id of the command
+ *
+ * Return 0 on success or negative value in case of error.
+ */
 int as10x_rsp_parse(struct as10x_cmd_t *prsp, uint16_t proc_id)
 {
 	int error;
@@ -455,5 +450,3 @@ int as10x_rsp_parse(struct as10x_cmd_t *prsp, uint16_t proc_id)
 
 	return AS10X_CMD_ERROR;
 }
-
-