Commit ceecd1bf authored by Randy Dunlap's avatar Randy Dunlap Committed by Jiri Kosina
Browse files

HID: correct kernel-doc notation in <linux/hid*.h> 



Correct kernel-doc notation in HID header files (include/linux/hid*.h).
Add notation (comments) where it is missing.
Use the documented "Return:" notation for function return values.
Fix a few typos/spellos.

Signed-off-by: default avatarRandy 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: default avatarJiri Kosina <jkosina@suse.cz>
parent 356006a6

include/linux/hid-sensor-hub.h

+5 −4
Original line number Diff line number Diff line
@@ -150,7 +150,7 @@ int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev, 
* @info:	return information about attribute after parsing report

*

* Parses report and returns the attribute information such as report id,

* field index, units and exponet etc.

* field index, units and exponent etc.

*/

int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,

			u8 type,
@@ -167,7 +167,7 @@ int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev, 
* @is_signed:   If true then fields < 32 bits will be sign-extended

*

* Issues a synchronous or asynchronous read request for an input attribute.

* Returns data upto 32 bits.

* Return: data up to 32 bits.

*/



enum sensor_hub_read_flags {
@@ -205,8 +205,9 @@ int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id, 
* @buffer:	buffer to copy output

*

* Used to get a field in feature report. For example this can get polling

* interval, sensitivity, activate/deactivate state. On success it returns

* number of bytes copied to buffer. On failure, it returns value < 0.

* interval, sensitivity, activate/deactivate state.

* Return: On success, it returns the number of bytes copied to buffer.

* On failure, it returns value < 0.

*/

int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,

			   u32 field_index, int buffer_size, void *buffer);

include/linux/hid.h

+11 −4
Original line number Diff line number Diff line
@@ -918,7 +918,7 @@ __u32 hid_field_extract(const struct hid_device *hid, __u8 *report, 
/**

 * hid_device_io_start - enable HID input during probe, remove

 *

 * @hid - the device

 * @hid: the device

 *

 * This should only be called during probe or remove and only be

 * called by the thread calling probe or remove. It will allow
@@ -936,7 +936,7 @@ static inline void hid_device_io_start(struct hid_device *hid) { 
/**

 * hid_device_io_stop - disable HID input during probe, remove

 *

 * @hid - the device

 * @hid: the device

 *

 * Should only be called after hid_device_io_start. It will prevent

 * incoming packets from going to the driver for the duration of
@@ -1010,6 +1010,13 @@ static inline void hid_map_usage(struct hid_input *hidinput, 
/**

 * hid_map_usage_clear - map usage input bits and clear the input bit

 *

 * @hidinput: hidinput which we are interested in

 * @usage: usage to fill in

 * @bit: pointer to input->{}bit (out parameter)

 * @max: maximal valid usage->code to consider later (out parameter)

 * @type: input event type (EV_KEY, EV_REL, ...)

 * @c: code which corresponds to this usage and type

 *

 * The same as hid_map_usage, except the @c bit is also cleared in supported

 * bits (@bit).

 */
@@ -1084,7 +1091,7 @@ static inline void hid_hw_request(struct hid_device *hdev, 
 * @rtype: HID report type

 * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT

 *

 * @return: count of data transfered, negative if error

 * Return: count of data transferred, negative if error

 *

 * Same behavior as hid_hw_request, but with raw buffers instead.

 */
@@ -1106,7 +1113,7 @@ static inline int hid_hw_raw_request(struct hid_device *hdev, 
 * @buf: raw data to transfer

 * @len: length of buf

 *

 * @return: count of data transfered, negative if error

 * Return: count of data transferred, negative if error

 */

static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,

					size_t len)