module: fix up 'kernel-doc' comments
authorSergey Shtylyov <s.shtylyov@omprussia.ru>
Wed, 4 Nov 2020 20:34:59 +0000 (23:34 +0300)
committerJessica Yu <jeyu@kernel.org>
Mon, 9 Nov 2020 12:46:58 +0000 (13:46 +0100)
Some 'kernel-doc' function comments do not fully comply with the specified
format due to:

- missing () after the function name;

- "RETURNS:"/"Returns:" instead of "Return:" when documenting the function's
  result.

- empty line before describing the function's arguments.

Signed-off-by: Sergey Shtylyov <s.shtylyov@omprussia.ru>
Signed-off-by: Jessica Yu <jeyu@kernel.org>
kernel/module.c

index 948d4bb..98b9e2b 100644 (file)
@@ -727,13 +727,12 @@ bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
 }
 
 /**
- * is_module_percpu_address - test whether address is from module static percpu
+ * is_module_percpu_address() - test whether address is from module static percpu
  * @addr: address to test
  *
  * Test whether @addr belongs to module static percpu area.
  *
- * RETURNS:
- * %true if @addr is from module static percpu area
+ * Return: %true if @addr is from module static percpu area
  */
 bool is_module_percpu_address(unsigned long addr)
 {
@@ -957,11 +956,10 @@ static int try_stop_module(struct module *mod, int flags, int *forced)
 }
 
 /**
- * module_refcount - return the refcount or -1 if unloading
- *
+ * module_refcount() - return the refcount or -1 if unloading
  * @mod:       the module we're checking
  *
- * Returns:
+ * Return:
  *     -1 if the module is in the process of unloading
  *     otherwise the number of references in the kernel to the module
  */