[PATCH] kernel-docs: fix kernel-doc format problems
Convert to proper kernel-doc format.
Some have extra blank lines (not allowed immed. after the function name)
or need blank lines (after all parameters). Function summary must be only
one line.
Colon (":") in a function description does weird things (causes kernel-doc
to think that it's a new section head sadly).
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
diff --git a/drivers/block/ll_rw_blk.c b/drivers/block/ll_rw_blk.c
index 2747741..5f52e30 100644
--- a/drivers/block/ll_rw_blk.c
+++ b/drivers/block/ll_rw_blk.c
@@ -706,7 +706,6 @@
/**
* blk_queue_find_tag - find a request by its tag and queue
- *
* @q: The request queue for the device
* @tag: The tag of the request
*
diff --git a/fs/fs-writeback.c b/fs/fs-writeback.c
index 1361a4a..785c721 100644
--- a/fs/fs-writeback.c
+++ b/fs/fs-writeback.c
@@ -606,7 +606,7 @@
* O_SYNC flag set, to flush dirty writes to disk.
*
* @what is a bitmask, specifying which part of the inode's data should be
- * written and waited upon:
+ * written and waited upon.
*
* OSYNC_DATA: i_mapping's dirty data
* OSYNC_METADATA: the buffers at i_mapping->private_list
@@ -672,8 +672,9 @@
/**
* writeback_in_progress: determine whether there is writeback in progress
- * against a backing device.
* @bdi: the device's backing_dev_info structure.
+ *
+ * Determine whether there is writeback in progress against a backing device.
*/
int writeback_in_progress(struct backing_dev_info *bdi)
{
diff --git a/include/linux/kernel.h b/include/linux/kernel.h
index f1925cc..b641948 100644
--- a/include/linux/kernel.h
+++ b/include/linux/kernel.h
@@ -266,7 +266,6 @@
/**
* container_of - cast a member of a structure out to the containing structure
- *
* @ptr: the pointer to the member.
* @type: the type of the container struct this is embedded in.
* @member: the name of the member within the struct.
diff --git a/kernel/sys.c b/kernel/sys.c
index 3e33213..bce933e 100644
--- a/kernel/sys.c
+++ b/kernel/sys.c
@@ -386,7 +386,7 @@
/**
* kernel_restart - reboot the system
* @cmd: pointer to buffer containing command to execute for restart
- * or NULL
+ * or %NULL
*
* Shutdown everything and perform a clean reboot.
* This is not safe to call in interrupt context.
