Skip to content

Commit 2914174

Browse files
jfischer-nokartben
authored andcommitted
doc: usb: minor fixes to improve consistency
Follow-up on newly introduced USB MIDI2 support. Prefix with usbd_, use midi2 consistently. Signed-off-by: Johann Fischer <[email protected]>
1 parent 6f55a32 commit 2914174

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

doc/connectivity/usb/device_next/api/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ New USB device support APIs
1111
usbd_hid_device.rst
1212
uac2_device.rst
1313
usbd_msc_device.rst
14-
usb_midi.rst
14+
usbd_midi2.rst
1515
usbd_dfu.rst
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _usb_midi:
1+
.. _usbd_midi2:
22

33
MIDI 2.0 Class device API
44
#########################
@@ -8,5 +8,5 @@ USB MIDI 2.0 device specific API defined in :zephyr_file:`include/zephyr/usb/cla
88
API Reference
99
*************
1010

11-
.. doxygengroup:: usb_midi
11+
.. doxygengroup:: usbd_midi2
1212
.. doxygengroup:: midi_ump

include/zephyr/usb/class/usbd_midi2.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ extern "C" {
1313

1414
/**
1515
* @brief USB MIDI 2.0 class device API
16-
* @defgroup usb_midi USB MIDI 2.0 Class device API
16+
* @defgroup usbd_midi2 USB MIDI 2.0 Class device API
1717
* @ingroup usb
1818
* @since 4.1
1919
* @version 0.1.0

samples/subsys/usb/midi/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. zephyr:code-sample:: midi
2-
:name: USB MIDI device class
3-
:relevant-api: usbd_api usb_midi input_events
1+
.. zephyr:code-sample:: usb-midi2-device
2+
:name: USB MIDI2 device
3+
:relevant-api: usbd_api usbd_midi2 input_events
44

5-
Implements a simple USB-MIDI loopback and keyboard device.
5+
Implements a simple USB MIDI loopback and keyboard device.
66

77
Overview
88
********

0 commit comments

Comments
 (0)