djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc fixes

Browse Source
This commit is contained in:
Dan Halbert 2021-04-29 23:51:39 -04:00
parent 48dd54cb85
commit b8b20faa20
2 changed files with 8 additions and 7 deletions
shared-bindings/usb_hid
Device.c__init__.c

14
shared-bindings/usb_hid/Device.c

@ -36,25 +36,25 @@
//| import usb_hid //| import usb_hid
//| //|
//| mouse = usb_hid.devices[0] //| mouse = usb_hid.devices[0]
//|
//| mouse.send_report()""" //| mouse.send_report()"""
//| //|
//| def __init__(self, *, descriptor: ReadableBuffer, usage_page: int, usage: int, in_report_length: int, out_report_length: Optional[int], , report_id_index: Optional[int]) -> None: //| def __init__(self, *, descriptor: ReadableBuffer, usage_page: int, usage: int, in_report_length: int, out_report_length: Optional[int], report_id_index: Optional[int]) -> None:
//| """Create a description of a USB HID device. To create an actual device, //| """Create a description of a USB HID device. To create an actual device,
//| pass a `Device` to `usb_hid.configure_usb()`. //| pass a `Device` to `usb_hid.configure_usb()`.
//| //|
//| :param ReadableBuffer report_descriptor: The USB HID Report descriptor bytes. The descriptor is not //| :param ReadableBuffer report_descriptor: The USB HID Report descriptor bytes. The descriptor is not
//| not verified for correctness; it is up to you to make sure it is not malformed. //| not verified for correctness; it is up to you to make sure it is not malformed.
//| :param int usage_page: The Usage Page value from the descriptor. Must match what is in the descriptor. //| :param int usage_page: The Usage Page value from the descriptor. Must match what is in the descriptor.
//| :param int usage: The Usage value from the descriptor. Must match what is in the descriptor. //| :param int usage: The Usage value from the descriptor. Must match what is in the descriptor.
//| :param int in_report_length: Size in bytes of the HID report sent to the host. //| :param int in_report_length: Size in bytes of the HID report sent to the host.
//| "In" is with respect to the host. //| "In" is with respect to the host.
//| :param int out_report_length: Size in bytes of the HID report received from the host. //| :param int out_report_length: Size in bytes of the HID report received from the host.
//| "Out" is with respect to the host. If no reports are expected, use ``None``. //| "Out" is with respect to the host. If no reports are expected, use ``None``.
//| :param int report_id_index: position of byte in descriptor that contains the Report ID. //| :param int report_id_index: position of byte in descriptor that contains the Report ID.
//| A Report ID will be assigned when the device is created. If there is no //| A Report ID will be assigned when the device is created. If there is no
//| Report ID, use ``None``. //| Report ID, use ``None``.
//| """
//| ... //| ...
//| //|
STATIC mp_obj_t usb_hid_device_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { STATIC mp_obj_t usb_hid_device_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {

1
shared-bindings/usb_hid/__init__.c

@ -48,6 +48,7 @@
//| If `devices` is empty, HID is disabled. The order of the ``Devices`` //| If `devices` is empty, HID is disabled. The order of the ``Devices``
//| may matter to the host. For instance, for MacOS, put the mouse device //| may matter to the host. For instance, for MacOS, put the mouse device
//| before any Gamepad or Digitizer HID device or else it will not work. //| before any Gamepad or Digitizer HID device or else it will not work.
//| """
//| ... //| ...
//| //|
STATIC mp_obj_t usb_hid_configure_usb(mp_obj_t devices) { STATIC mp_obj_t usb_hid_configure_usb(mp_obj_t devices) {