Skip to content

Commit b68758e

Browse files
rddunlapsamitolvanen
authored andcommitted
modules: moduleparam.h: fix kernel-doc comments
Fix kernel-doc comments to prevent kernel-doc warnings: Warning: include/linux/moduleparam.h:364 function parameter 'arg' not described in '__core_param_cb' Warning: include/linux/moduleparam.h:395 No description found for return value of 'parameq' Warning: include/linux/moduleparam.h:405 No description found for return value of 'parameqn' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Petr Pavlu <petr.pavlu@suse.com> [Sami: Clarified the commit message] Signed-off-by: Sami Tolvanen <samitolvanen@google.com>
1 parent 1ae719a commit b68758e

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

include/linux/moduleparam.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,8 +355,8 @@ static inline void kernel_param_unlock(struct module *mod)
355355
/**
356356
* __core_param_cb - similar like core_param, with a set/get ops instead of type.
357357
* @name: the name of the cmdline and sysfs parameter (often the same as var)
358-
* @var: the variable
359358
* @ops: the set & get operations for this parameter.
359+
* @arg: the variable
360360
* @perm: visibility in sysfs
361361
*
362362
* Ideally this should be called 'core_param_cb', but the name has been
@@ -390,7 +390,7 @@ static inline void kernel_param_unlock(struct module *mod)
390390
* @name1: parameter name 1
391391
* @name2: parameter name 2
392392
*
393-
* Returns true if the two parameter names are equal.
393+
* Returns: true if the two parameter names are equal.
394394
* Dashes (-) are considered equal to underscores (_).
395395
*/
396396
extern bool parameq(const char *name1, const char *name2);
@@ -402,6 +402,10 @@ extern bool parameq(const char *name1, const char *name2);
402402
* @n: the length to compare
403403
*
404404
* Similar to parameq(), except it compares @n characters.
405+
*
406+
* Returns: true if the first @n characters of the two parameter names
407+
* are equal.
408+
* Dashes (-) are considered equal to underscores (_).
405409
*/
406410
extern bool parameqn(const char *name1, const char *name2, size_t n);
407411

0 commit comments

Comments
 (0)