[PATCH] Numerous fixes to kernel-doc info in source files.

A variety of (mostly) innocuous fixes to the embedded kernel-doc content in
source files, including:

  * make multi-line initial descriptions single line
  * denote some function names, constants and structs as such
  * change erroneous opening '/*' to '/**' in a few places
  * reword some text for clarity

Signed-off-by: Robert P. J. Day <rpjday@mindspring.com>
Cc: "Randy.Dunlap" <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

1 files changed, 10 insertions, 11 deletions

diff --git a/ipc/util.c b/ipc/util.c
index a9b7a227b8d4..0c97cb746160 100644
--- a/ipc/util.c
+++ b/ipc/util.c
@@ -150,7 +150,7 @@ void free_ipc_ns(struct kref *kref)
  *      ipc_init        -       initialise IPC subsystem
  *
  *      The various system5 IPC resources (semaphores, messages and shared
- *      memory are initialised
+ *      memory) are initialised
  */
  
 static int __init ipc_init(void)
@@ -207,8 +207,7 @@ void __ipc_init ipc_init_ids(struct ipc_ids* ids, int size)
 #ifdef CONFIG_PROC_FS
 static struct file_operations sysvipc_proc_fops;
 /**
- *      ipc_init_proc_interface -  Create a proc interface for sysipc types
- *                                 using a seq_file interface.
+ *      ipc_init_proc_interface -  Create a proc interface for sysipc types using a seq_file interface.
  *      @path: Path in procfs
  *      @header: Banner to be printed at the beginning of the file.
  *      @ids: ipc id table to iterate.
@@ -417,7 +416,7 @@ void* ipc_alloc(int size)
  *      @ptr: pointer returned by ipc_alloc
  *      @size: size of block
  *
- *      Free a block created with ipc_alloc. The caller must know the size
+ *      Free a block created with ipc_alloc(). The caller must know the size
  *      used in the allocation call.
  */
 
@@ -524,7 +523,7 @@ static void ipc_do_vfree(struct work_struct *work)
  * @head: RCU callback structure for queued work
  * 
  * Since RCU callback function is called in bh,
- * we need to defer the vfree to schedule_work
+ * we need to defer the vfree to schedule_work().
  */
 static void ipc_schedule_free(struct rcu_head *head)
 {
@@ -541,7 +540,7 @@ static void ipc_schedule_free(struct rcu_head *head)
  * ipc_immediate_free - free ipc + rcu space
  * @head: RCU callback structure that contains pointer to be freed
  *
- * Free from the RCU callback context
+ * Free from the RCU callback context.
  */
 static void ipc_immediate_free(struct rcu_head *head)
 {
@@ -603,8 +602,8 @@ int ipcperms (struct kern_ipc_perm *ipcp, short flag)
  *      @in: kernel permissions
  *      @out: new style IPC permissions
  *
- *      Turn the kernel object 'in' into a set of permissions descriptions
- *      for returning to userspace (out).
+ *      Turn the kernel object @in into a set of permissions descriptions
+ *      for returning to userspace (@out).
  */
  
 
@@ -624,8 +623,8 @@ void kernel_to_ipc64_perm (struct kern_ipc_perm *in, struct ipc64_perm *out)
  *      @in: new style IPC permissions
  *      @out: old style IPC permissions
  *
- *      Turn the new style permissions object in into a compatibility
- *      object and store it into the 'out' pointer.
+ *      Turn the new style permissions object @in into a compatibility
+ *      object and store it into the @out pointer.
  */
  
 void ipc64_perm_to_ipc_perm (struct ipc64_perm *in, struct ipc_perm *out)
@@ -722,7 +721,7 @@ int ipc_checkid(struct ipc_ids* ids, struct kern_ipc_perm* ipcp, int uid)
  *      @cmd: pointer to command
  *
  *      Return IPC_64 for new style IPC and IPC_OLD for old style IPC. 
- *      The cmd value is turned from an encoding command and version into
+ *      The @cmd value is turned from an encoding command and version into
  *      just the command code.
  */