hailey
/
qmk_firmware
mirror of https://github.com/hailey/qmk_firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Doxygen formatting of parameters for the CALLBACK_HID_Device_CreateHIDReport() function in the ClassDriver HID device demos.

Browse Source
Dean Camera 15 years ago
parent 55d7e1e65b
commit 26afe5fe9e
7 changed files with 34 additions and 34 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 10
      Demos/Device/ClassDriver/GenericHID/GenericHID.c
  2. 10
      Demos/Device/ClassDriver/Joystick/Joystick.c
  3. 10
      Demos/Device/ClassDriver/Keyboard/Keyboard.c
  4. 8
      Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
  5. 10
      Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c
  6. 10
      Demos/Device/ClassDriver/Mouse/Mouse.c
  7. 10
      Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c

10
Demos/Device/ClassDriver/GenericHID/GenericHID.c
Unescape View File

@ -135,11 +135,11 @@ void EVENT_USB_Device_StartOfFrame(void)
/** HID class driver callback function for the creation of HID reports to the host. /** HID class driver callback function for the creation of HID reports to the host.
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature * \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *
* \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
*/ */

10
Demos/Device/ClassDriver/Joystick/Joystick.c
Unescape View File

@ -129,11 +129,11 @@ void EVENT_USB_Device_StartOfFrame(void)
/** HID class driver callback function for the creation of HID reports to the host. /** HID class driver callback function for the creation of HID reports to the host.
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature * \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *
* \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
*/ */

10
Demos/Device/ClassDriver/Keyboard/Keyboard.c
Unescape View File

@ -129,11 +129,11 @@ void EVENT_USB_Device_StartOfFrame(void)
/** HID class driver callback function for the creation of HID reports to the host. /** HID class driver callback function for the creation of HID reports to the host.
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature * \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *
* \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
*/ */

8
Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
Unescape View File

@ -157,11 +157,11 @@ void EVENT_USB_Device_StartOfFrame(void)
/** HID class driver callback function for the creation of HID reports to the host. /** HID class driver callback function for the creation of HID reports to the host.
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature * \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *
* \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
*/ */

10
Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c
Unescape View File

@ -177,11 +177,11 @@ void EVENT_USB_Device_StartOfFrame(void)
/** HID class driver callback function for the creation of HID reports to the host. /** HID class driver callback function for the creation of HID reports to the host.
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature * \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *
* \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
*/ */

10
Demos/Device/ClassDriver/Mouse/Mouse.c
Unescape View File

@ -129,11 +129,11 @@ void EVENT_USB_Device_StartOfFrame(void)
/** HID class driver callback function for the creation of HID reports to the host. /** HID class driver callback function for the creation of HID reports to the host.
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature * \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *
* \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
*/ */

10
Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
Unescape View File

@ -191,11 +191,11 @@ void EVENT_USB_Device_StartOfFrame(void)
/** HID class driver callback function for the creation of HID reports to the host. /** HID class driver callback function for the creation of HID reports to the host.
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature * \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *
* \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
*/ */

Write Preview
Loading…
Cancel
Save