| Message ID | 20210311102022.96954-4-hverkuil-cisco@xs4all.nl |
|---|---|
| State | Accepted |
| Commit | 7bc69c9693ed2dd78048c183408b0bc8c144264b |
| Headers | show |
| Series | media platform: fix kernel-doc formatting | expand |
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
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; };
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(-)