Commit b8887e6e authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds

[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: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 1e5d5331
...@@ -706,7 +706,6 @@ EXPORT_SYMBOL(blk_queue_dma_alignment); ...@@ -706,7 +706,6 @@ EXPORT_SYMBOL(blk_queue_dma_alignment);
/** /**
* blk_queue_find_tag - find a request by its tag and queue * blk_queue_find_tag - find a request by its tag and queue
*
* @q: The request queue for the device * @q: The request queue for the device
* @tag: The tag of the request * @tag: The tag of the request
* *
......
...@@ -606,7 +606,7 @@ EXPORT_SYMBOL(sync_inode); ...@@ -606,7 +606,7 @@ EXPORT_SYMBOL(sync_inode);
* O_SYNC flag set, to flush dirty writes to disk. * O_SYNC flag set, to flush dirty writes to disk.
* *
* @what is a bitmask, specifying which part of the inode's data should be * @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_DATA: i_mapping's dirty data
* OSYNC_METADATA: the buffers at i_mapping->private_list * OSYNC_METADATA: the buffers at i_mapping->private_list
...@@ -672,8 +672,9 @@ int writeback_acquire(struct backing_dev_info *bdi) ...@@ -672,8 +672,9 @@ int writeback_acquire(struct backing_dev_info *bdi)
/** /**
* writeback_in_progress: determine whether there is writeback in progress * writeback_in_progress: determine whether there is writeback in progress
* against a backing device.
* @bdi: the device's backing_dev_info structure. * @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) int writeback_in_progress(struct backing_dev_info *bdi)
{ {
......
...@@ -266,7 +266,6 @@ extern void dump_stack(void); ...@@ -266,7 +266,6 @@ extern void dump_stack(void);
/** /**
* container_of - cast a member of a structure out to the containing structure * container_of - cast a member of a structure out to the containing structure
*
* @ptr: the pointer to the member. * @ptr: the pointer to the member.
* @type: the type of the container struct this is embedded in. * @type: the type of the container struct this is embedded in.
* @member: the name of the member within the struct. * @member: the name of the member within the struct.
......
...@@ -386,7 +386,7 @@ void kernel_restart_prepare(char *cmd) ...@@ -386,7 +386,7 @@ void kernel_restart_prepare(char *cmd)
/** /**
* kernel_restart - reboot the system * kernel_restart - reboot the system
* @cmd: pointer to buffer containing command to execute for restart * @cmd: pointer to buffer containing command to execute for restart
* or NULL * or %NULL
* *
* Shutdown everything and perform a clean reboot. * Shutdown everything and perform a clean reboot.
* This is not safe to call in interrupt context. * This is not safe to call in interrupt context.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment