module: fix up 'kernel-doc' comments

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>
This commit is contained in:
Sergey Shtylyov 2020-11-04 23:34:59 +03:00 committed by Jessica Yu
parent 076aa52e40
commit 24389b610b

View 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
*/