dma-buf: Fix kerneldoc comment for struct dma_fence_array
authorJonathan Corbet <corbet@lwn.net>
Wed, 16 Jan 2019 22:34:36 +0000 (15:34 -0700)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Thu, 17 Jan 2019 09:12:32 +0000 (10:12 +0100)
The kerneldoc comment for struct dma_fence_array lacks a description
of the "work" member, leading to this docs-build warning:

  ./include/linux/dma-fence-array.h:54: warning: Function parameter or member 'work' not described in 'dma_fence_array'

Add a description and make the warning go away.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20190116153436.3b244cda@lwn.net
include/linux/dma-fence-array.h

index bc8940ca280dc74c36c706dc6d7c831a39381cc4..c0ff417b477063d50eb7e168679843001a122efe 100644 (file)
@@ -40,6 +40,7 @@ struct dma_fence_array_cb {
  * @num_fences: number of fences in the array
  * @num_pending: fences in the array still pending
  * @fences: array of the fences
+ * @work: internal irq_work function
  */
 struct dma_fence_array {
        struct dma_fence base;