Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

HID: correct kernel-doc notation in hid-quirks.c

Use correct kernel-doc notation for functions.
Add notation (comments) where it is missing.
Use the documented "Return:" notation for function return values.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: linux-input@vger.kernel.org
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

authored by

Randy Dunlap and committed by
Jiri Kosina
0603616a ceecd1bf

+14 -11
+14 -11
drivers/hid/hid-quirks.c
··· 1029 1029 /* Runtime ("dynamic") quirks manipulation functions */ 1030 1030 1031 1031 /** 1032 - * hid_exists_dquirk: find any dynamic quirks for a HID device 1032 + * hid_exists_dquirk - find any dynamic quirks for a HID device 1033 1033 * @hdev: the HID device to match 1034 1034 * 1035 1035 * Description: ··· 1037 1037 * the pointer to the relevant struct hid_device_id if found. 1038 1038 * Must be called with a read lock held on dquirks_lock. 1039 1039 * 1040 - * Returns: NULL if no quirk found, struct hid_device_id * if found. 1040 + * Return: NULL if no quirk found, struct hid_device_id * if found. 1041 1041 */ 1042 1042 static struct hid_device_id *hid_exists_dquirk(const struct hid_device *hdev) 1043 1043 { ··· 1061 1061 1062 1062 1063 1063 /** 1064 - * hid_modify_dquirk: add/replace a HID quirk 1064 + * hid_modify_dquirk - add/replace a HID quirk 1065 1065 * @id: the HID device to match 1066 1066 * @quirks: the unsigned long quirks value to add/replace 1067 1067 * ··· 1070 1070 * quirks value with what was provided. Otherwise, add the quirk 1071 1071 * to the dynamic quirks list. 1072 1072 * 1073 - * Returns: 0 OK, -error on failure. 1073 + * Return: 0 OK, -error on failure. 1074 1074 */ 1075 1075 static int hid_modify_dquirk(const struct hid_device_id *id, 1076 1076 const unsigned long quirks) ··· 1122 1122 } 1123 1123 1124 1124 /** 1125 - * hid_remove_all_dquirks: remove all runtime HID quirks from memory 1125 + * hid_remove_all_dquirks - remove all runtime HID quirks from memory 1126 1126 * @bus: bus to match against. Use HID_BUS_ANY if all need to be removed. 1127 1127 * 1128 1128 * Description: ··· 1146 1146 } 1147 1147 1148 1148 /** 1149 - * hid_quirks_init: apply HID quirks specified at module load time 1149 + * hid_quirks_init - apply HID quirks specified at module load time 1150 + * @quirks_param: array of quirks strings (vendor:product:quirks) 1151 + * @bus: bus type 1152 + * @count: number of quirks to check 1150 1153 */ 1151 1154 int hid_quirks_init(char **quirks_param, __u16 bus, int count) 1152 1155 { ··· 1180 1177 EXPORT_SYMBOL_GPL(hid_quirks_init); 1181 1178 1182 1179 /** 1183 - * hid_quirks_exit: release memory associated with dynamic_quirks 1180 + * hid_quirks_exit - release memory associated with dynamic_quirks 1184 1181 * @bus: a bus to match against 1185 1182 * 1186 1183 * Description: ··· 1197 1194 EXPORT_SYMBOL_GPL(hid_quirks_exit); 1198 1195 1199 1196 /** 1200 - * hid_gets_squirk: return any static quirks for a HID device 1197 + * hid_gets_squirk - return any static quirks for a HID device 1201 1198 * @hdev: the HID device to match 1202 1199 * 1203 1200 * Description: 1204 1201 * Given a HID device, return a pointer to the quirked hid_device_id entry 1205 1202 * associated with that device. 1206 1203 * 1207 - * Returns: the quirks. 1204 + * Return: the quirks. 1208 1205 */ 1209 1206 static unsigned long hid_gets_squirk(const struct hid_device *hdev) 1210 1207 { ··· 1228 1225 } 1229 1226 1230 1227 /** 1231 - * hid_lookup_quirk: return any quirks associated with a HID device 1228 + * hid_lookup_quirk - return any quirks associated with a HID device 1232 1229 * @hdev: the HID device to look for 1233 1230 * 1234 1231 * Description: 1235 1232 * Given a HID device, return any quirks associated with that device. 1236 1233 * 1237 - * Returns: an unsigned long quirks value. 1234 + * Return: an unsigned long quirks value. 1238 1235 */ 1239 1236 unsigned long hid_lookup_quirk(const struct hid_device *hdev) 1240 1237 {