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>

diff --git a/include/linux/moduleparam.h b/include/linux/moduleparam.h
index 915f32f7d8888a9028b8767e0d90261e2f5083d4..c03db3c2fd40a1fdead66af24a3a1d8318406a9d 100644 (file)
--- a/include/linux/moduleparam.h
+++ b/include/linux/moduleparam.h
@@ -355,8 +355,8 @@ static inline void kernel_param_unlock(struct module *mod)
 /**
  * __core_param_cb - similar like core_param, with a set/get ops instead of type.
  * @name: the name of the cmdline and sysfs parameter (often the same as var)
- * @var: the variable
  * @ops: the set & get operations for this parameter.
+ * @arg: the variable
  * @perm: visibility in sysfs
  *
  * 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)
  * @name1: parameter name 1
  * @name2: parameter name 2
  *
- * Returns true if the two parameter names are equal.
+ * Returns: true if the two parameter names are equal.
  * Dashes (-) are considered equal to underscores (_).
  */
 extern bool parameq(const char *name1, const char *name2);
@@ -402,6 +402,10 @@ extern bool parameq(const char *name1, const char *name2);
  * @n: the length to compare
  *
  * Similar to parameq(), except it compares @n characters.
+ *
+ * Returns: true if the first @n characters of the two parameter names
+ * are equal.
+ * Dashes (-) are considered equal to underscores (_).
  */
 extern bool parameqn(const char *name1, const char *name2, size_t n);