[PATCH 05/15] dma-buf/sw_sync: improve function-level documentation

From: Julia Lawall
Date: Sat Oct 01 2016 - 16:07:52 EST


Adjust the documentation to use the names that appear in the function
parameter list.

Issue detected using Coccinelle (http://coccinelle.lip6.fr/)

Signed-off-by: Julia Lawall <Julia.Lawall@xxxxxxx>

---
drivers/dma-buf/sw_sync.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/dma-buf/sw_sync.c b/drivers/dma-buf/sw_sync.c
index 62e8e6d..5d2b1b6 100644
--- a/drivers/dma-buf/sw_sync.c
+++ b/drivers/dma-buf/sw_sync.c
@@ -155,11 +155,11 @@ static void sync_timeline_signal(struct sync_timeline *obj, unsigned int inc)

/**
* sync_pt_create() - creates a sync pt
- * @parent: fence's parent sync_timeline
+ * @obj: fence's parent sync_timeline
* @size: size to allocate for this pt
- * @inc: value of the fence
+ * @value: value of the fence
*
- * Creates a new sync_pt as a child of @parent. @size bytes will be
+ * Creates a new sync_pt as a child of @obj. @size bytes will be
* allocated allowing for implementation specific data to be kept after
* the generic sync_timeline struct. Returns the sync_pt object or
* NULL in case of error.