diff mbox series

[04/13] rcar-vin/rcar-vin.h: fix kernel-doc formatting

Message ID 20210311102022.96954-5-hverkuil-cisco@xs4all.nl
State Accepted
Commit 091263973d4a43d298a2a8e0c302405ee536fd36
Headers show
Series media platform: fix kernel-doc formatting | expand

Commit Message

Hans Verkuil March 11, 2021, 10:20 a.m. UTC
Fix formatting of two enums and one struct.

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
---
 drivers/media/platform/rcar-vin/rcar-vin.h | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

Comments

Niklas Söderlund March 11, 2021, 12:12 p.m. UTC | #1
Hi Hans,

Thanks for your patch.

On 2021-03-11 11:20:13 +0100, Hans Verkuil wrote:
> Fix formatting of two enums and one struct.
> 
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> Cc: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>

Reviewed-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>

> ---
>  drivers/media/platform/rcar-vin/rcar-vin.h | 19 ++++++++++---------
>  1 file changed, 10 insertions(+), 9 deletions(-)
> 
> diff --git a/drivers/media/platform/rcar-vin/rcar-vin.h b/drivers/media/platform/rcar-vin/rcar-vin.h
> index 0ee9d402f5ac..b263ead4db2b 100644
> --- a/drivers/media/platform/rcar-vin/rcar-vin.h
> +++ b/drivers/media/platform/rcar-vin/rcar-vin.h
> @@ -49,11 +49,12 @@ enum rvin_csi_id {
>  };
>  
>  /**
> - * STOPPED   - No operation in progress
> - * STARTING  - Capture starting up
> - * RUNNING   - Operation in progress have buffers
> - * STOPPING  - Stopping operation
> - * SUSPENDED - Capture is suspended
> + * enum rvin_dma_state - DMA states
> + * @STOPPED:   No operation in progress
> + * @STARTING:  Capture starting up
> + * @RUNNING:   Operation in progress have buffers
> + * @STOPPING:  Stopping operation
> + * @SUSPENDED: Capture is suspended
>   */
>  enum rvin_dma_state {
>  	STOPPED = 0,
> @@ -70,9 +71,9 @@ enum rvin_dma_state {
>   * to capture SEQ_TB/BT it's needed to capture to the same vb2
>   * buffer twice so the type of buffer needs to be kept.
>   *
> - * FULL - One capture fills the whole vb2 buffer
> - * HALF_TOP - One capture fills the top half of the vb2 buffer
> - * HALF_BOTTOM - One capture fills the bottom half of the vb2 buffer
> + * @FULL: One capture fills the whole vb2 buffer
> + * @HALF_TOP: One capture fills the top half of the vb2 buffer
> + * @HALF_BOTTOM: One capture fills the bottom half of the vb2 buffer
>   */
>  enum rvin_buffer_type {
>  	FULL,
> @@ -191,7 +192,7 @@ struct rvin_info {
>   * @state:		keeps track of operation state
>   *
>   * @is_csi:		flag to mark the VIN as using a CSI-2 subdevice
> - * @chsel		Cached value of the current CSI-2 channel selection
> + * @chsel:		Cached value of the current CSI-2 channel selection
>   *
>   * @mbus_code:		media bus format code
>   * @format:		active V4L2 pixel format
> -- 
> 2.30.1
>
diff mbox series

Patch

diff --git a/drivers/media/platform/rcar-vin/rcar-vin.h b/drivers/media/platform/rcar-vin/rcar-vin.h
index 0ee9d402f5ac..b263ead4db2b 100644
--- a/drivers/media/platform/rcar-vin/rcar-vin.h
+++ b/drivers/media/platform/rcar-vin/rcar-vin.h
@@ -49,11 +49,12 @@  enum rvin_csi_id {
 };
 
 /**
- * STOPPED   - No operation in progress
- * STARTING  - Capture starting up
- * RUNNING   - Operation in progress have buffers
- * STOPPING  - Stopping operation
- * SUSPENDED - Capture is suspended
+ * enum rvin_dma_state - DMA states
+ * @STOPPED:   No operation in progress
+ * @STARTING:  Capture starting up
+ * @RUNNING:   Operation in progress have buffers
+ * @STOPPING:  Stopping operation
+ * @SUSPENDED: Capture is suspended
  */
 enum rvin_dma_state {
 	STOPPED = 0,
@@ -70,9 +71,9 @@  enum rvin_dma_state {
  * to capture SEQ_TB/BT it's needed to capture to the same vb2
  * buffer twice so the type of buffer needs to be kept.
  *
- * FULL - One capture fills the whole vb2 buffer
- * HALF_TOP - One capture fills the top half of the vb2 buffer
- * HALF_BOTTOM - One capture fills the bottom half of the vb2 buffer
+ * @FULL: One capture fills the whole vb2 buffer
+ * @HALF_TOP: One capture fills the top half of the vb2 buffer
+ * @HALF_BOTTOM: One capture fills the bottom half of the vb2 buffer
  */
 enum rvin_buffer_type {
 	FULL,
@@ -191,7 +192,7 @@  struct rvin_info {
  * @state:		keeps track of operation state
  *
  * @is_csi:		flag to mark the VIN as using a CSI-2 subdevice
- * @chsel		Cached value of the current CSI-2 channel selection
+ * @chsel:		Cached value of the current CSI-2 channel selection
  *
  * @mbus_code:		media bus format code
  * @format:		active V4L2 pixel format