All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
To: Hans Verkuil <hverkuil-cisco@xs4all.nl>, linux-media@vger.kernel.org
Subject: Re: [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting
Date: Tue, 16 Mar 2021 17:03:43 +0200	[thread overview]
Message-ID: <bb9e76ca-2b75-ed80-8bcc-d6d8451d1a58@ideasonboard.com> (raw)
In-Reply-To: <20210311102022.96954-4-hverkuil-cisco@xs4all.nl>

On 11/03/2021 12:20, Hans Verkuil wrote:
> Fix inline struct member documentation, was missing the
> '@memb:' prefix.
> 
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> Cc: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
> ---
>   drivers/media/platform/ti-vpe/cal.h | 19 +++++++++----------
>   1 file changed, 9 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/media/platform/ti-vpe/cal.h b/drivers/media/platform/ti-vpe/cal.h
> index d471b7f82519..7aaea82c6b42 100644
> --- a/drivers/media/platform/ti-vpe/cal.h
> +++ b/drivers/media/platform/ti-vpe/cal.h
> @@ -84,35 +84,34 @@ struct cal_buffer {
>   
>   /**
>    * struct cal_dmaqueue - Queue of DMA buffers
> - * @active: Buffer being DMA'ed to for the current frame
>    */
>   struct cal_dmaqueue {
>   	/**
> -	 * Protects all fields in the cal_dmaqueue.
> +	 * @lock: Protects all fields in the cal_dmaqueue.
>   	 */
>   	spinlock_t		lock;
>   
>   	/**
> -	 * Buffers queued to the driver and waiting for DMA processing.
> +	 * @queue: Buffers queued to the driver and waiting for DMA processing.
>   	 * Buffers are added to the list by the vb2 .buffer_queue() operation,
>   	 * and move to @pending when they are scheduled for the next frame.
>   	 */
>   	struct list_head	queue;
>   	/**
> -	 * Buffer provided to the hardware to DMA the next frame. Will move to
> -	 * @active at the end of the current frame.
> +	 * @pending: Buffer provided to the hardware to DMA the next frame.
> +	 * Will move to @active at the end of the current frame.
>   	 */
>   	struct cal_buffer	*pending;
>   	/**
> -	 * Buffer being DMA'ed to for the current frame. Will be retired and
> -	 * given back to vb2 at the end of the current frame if a @pending
> -	 * buffer has been scheduled to replace it.
> +	 * @active: Buffer being DMA'ed to for the current frame. Will be
> +	 * retired and given back to vb2 at the end of the current frame if
> +	 * a @pending buffer has been scheduled to replace it.
>   	 */
>   	struct cal_buffer	*active;
>   
> -	/** State of the DMA engine. */
> +	/** @state: State of the DMA engine. */
>   	enum cal_dma_state	state;
> -	/** Wait queue to signal a @state transition to CAL_DMA_STOPPED. */
> +	/** @wait: Wait queue to signal a @state transition to CAL_DMA_STOPPED. */
>   	struct wait_queue_head	wait;
>   };
>   
> 

Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>

  Tomi

  reply	other threads:[~2021-03-16 15:04 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
2021-03-11 10:20 ` [PATCH 01/13] exynos-gsc/exynos4-is: add missing 'struct' to kerneldoc Hans Verkuil
2021-03-11 10:20 ` [PATCH 02/13] s5p-jpeg: fix kernel-doc warnings Hans Verkuil
2021-03-11 10:20 ` [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting Hans Verkuil
2021-03-16 15:03   ` Tomi Valkeinen [this message]
2021-03-11 10:20 ` [PATCH 04/13] rcar-vin/rcar-vin.h: " Hans Verkuil
2021-03-11 12:12   ` Niklas Söderlund
2021-03-11 10:20 ` [PATCH 05/13] media/platform/sti: " Hans Verkuil
2021-03-11 10:20 ` [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword Hans Verkuil
2021-03-11 12:12   ` Laurent Pinchart
2021-03-11 12:35     ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting Hans Verkuil
2021-03-11 14:19   ` Ezequiel Garcia
2021-03-11 10:20 ` [PATCH 08/13] staging: media: ipu3: add missing kernel-doc 'struct' keywords Hans Verkuil
2021-03-11 10:20 ` [PATCH 09/13] staging: media: meson: vdec: fix kernel-doc warning Hans Verkuil
2021-03-11 10:20 ` [PATCH 10/13] mtk-jpeg/mtk_jpeg_core.h: fix kernel-doc warnings Hans Verkuil
2021-03-11 10:20 ` [PATCH 11/13] mtk-mdp: " Hans Verkuil
2021-03-11 10:20 ` [PATCH 12/13] mtk-vcodec: " Hans Verkuil
2021-03-11 10:20 ` [PATCH 13/13] mtk-vpu/mtk_vpu.h: " Hans Verkuil

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bb9e76ca-2b75-ed80-8bcc-d6d8451d1a58@ideasonboard.com \
    --to=tomi.valkeinen@ideasonboard.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=linux-media@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.