[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>
diff --git a/drivers/staging/media/as102/as10x_cmd_cfg.c b/drivers/staging/media/as102/as10x_cmd_cfg.c
index dca2cbf..ec6f69f 100644
--- a/drivers/staging/media/as102/as10x_cmd_cfg.c
+++ b/drivers/staging/media/as102/as10x_cmd_cfg.c
@@ -27,13 +27,13 @@
/***************************/
/**
- \brief send get context command to AS10x
- \param phandle: pointer to AS10x handle
- \param tag: context tag
- \param pvalue: pointer where to store context value read
- \return 0 when no error, < 0 in case of error.
- \callgraph
-*/
+ * as10x_cmd_get_context - Send get context command to AS10x
+ * @phandle: pointer to AS10x handle
+ * @tag: context tag
+ * @pvalue: pointer where to store context value read
+ *
+ * Return 0 on success or negative value in case of error.
+ */
int as10x_cmd_get_context(as10x_handle_t *phandle, uint16_t tag,
uint32_t *pvalue)
{
@@ -86,13 +86,13 @@
}
/**
- \brief send set context command to AS10x
- \param phandle: pointer to AS10x handle
- \param tag: context tag
- \param value: value to set in context
- \return 0 when no error, < 0 in case of error.
- \callgraph
-*/
+ * as10x_cmd_set_context - send set context command to AS10x
+ * @phandle: pointer to AS10x handle
+ * @tag: context tag
+ * @value: value to set in context
+ *
+ * Return 0 on success or negative value in case of error.
+ */
int as10x_cmd_set_context(as10x_handle_t *phandle, uint16_t tag,
uint32_t value)
{
@@ -141,17 +141,16 @@
}
/**
- \brief send eLNA change mode command to AS10x
- \param phandle: pointer to AS10x handle
- \param tag: context tag
- \param mode: mode selected:
- - ON : 0x0 => eLNA always ON
- - OFF : 0x1 => eLNA always OFF
- - AUTO : 0x2 => eLNA follow hysteresis parameters to be
- ON or OFF
- \return 0 when no error, < 0 in case of error.
- \callgraph
-*/
+ * as10x_cmd_eLNA_change_mode - send eLNA change mode command to AS10x
+ * @phandle: pointer to AS10x handle
+ * @mode: mode selected:
+ * - ON : 0x0 => eLNA always ON
+ * - OFF : 0x1 => eLNA always OFF
+ * - AUTO : 0x2 => eLNA follow hysteresis parameters
+ * to be ON or OFF
+ *
+ * Return 0 on success or negative value in case of error.
+ */
int as10x_cmd_eLNA_change_mode(as10x_handle_t *phandle, uint8_t mode)
{
int error;
@@ -194,14 +193,14 @@
}
/**
- \brief Parse context command response. Since this command does not follow
- the common response, a specific parse function is required.
- \param prsp: pointer to AS10x command response buffer
- \param proc_id: id of the command
- \return 0 when no error, < 0 in case of error.
- ABILIS_RC_NOK
- \callgraph
-*/
+ * as10x_context_rsp_parse - Parse context command response
+ * @prsp: pointer to AS10x command response buffer
+ * @proc_id: id of the command
+ *
+ * Since the contex command reponse does not follow the common
+ * response, a specific parse function is required.
+ * Return 0 on success or negative value in case of error.
+ */
int as10x_context_rsp_parse(struct as10x_cmd_t *prsp, uint16_t proc_id)
{
int err;