Skip to content

Commit 0d33dc2

Browse files
committed
Correct typos in comments and documentation
1 parent 1c9942f commit 0d33dc2

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

README.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"]
77

8-
This library allows an Arduino board with USB capabilites to act as a MIDI instrument over USB. The library is based on PluggableUSB, so is only compatible with IDE 1.6.6 and nightly builds (AVR core > 1.6.8, SAM core > 1.6.4, SAMD core > 1.6.1)
8+
This library allows an Arduino board with USB capabilities to act as a MIDI instrument over USB. The library is based on PluggableUSB, so is only compatible with Arduino IDE 1.6.6 and newer.
99

1010
Furthermore, since PluggableUSB only targets boards with native USB capabilities, this library only supports these boards (eg. Leonardo, Micro, Due, Zero and so on)
1111

keywords.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#######################################
2-
# Syntax Coloring Map For Keyboard
2+
# Syntax Coloring Map For MIDIUSB
33
#######################################
44

55
#######################################

library.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name=MIDIUSB
22
version=1.0.5
33
author=Gary Grewal, Arduino
44
maintainer=Arduino <[email protected]>
5-
sentence=Allows an Arduino board with USB capabilites to act as a MIDI instrument over USB.
5+
sentence=Allows an Arduino board with USB capabilities to act as a MIDI instrument over USB.
66
paragraph=
77
category=Device Control
88
url=http://www.arduino.cc/en/Reference/MIDIUSB

src/MIDIUSB.h

+9-9
Original file line numberDiff line numberDiff line change
@@ -123,15 +123,15 @@ typedef struct
123123
uint8_t jackStrIndex;
124124
} MIDIJackOutDescriptor;
125125

126-
/// MIDI Jack EndPoint Descriptor, common to midi in and out jacks.
126+
/// MIDI Jack EndPoint Descriptor, common to MIDI in and out jacks.
127127
typedef struct
128128
{
129129
EndpointDescriptor len; // 9
130130
uint8_t refresh; // 4
131131
uint8_t sync;
132132
} MIDI_EPDescriptor;
133133

134-
/// MIDI Jack EndPoint AudioControl Descriptor, common to midi in and out ac jacks.
134+
/// MIDI Jack EndPoint AudioControl Descriptor, common to MIDI in and out ac jacks.
135135
typedef struct
136136
{
137137
uint8_t len; // 5
@@ -151,7 +151,7 @@ typedef struct
151151
uint16_t wTotalLength;
152152
} MIDI_ASInterfaceDescriptor;
153153

154-
/// Top Level MIDI Descriptor used to create a Midi Interface instace \see MIDI_::getInterface()
154+
/// Top Level MIDI Descriptor used to create a MIDI Interface instance \see MIDI_::getInterface()
155155
typedef struct
156156
{
157157
// IAD
@@ -197,7 +197,7 @@ typedef struct
197197
#define D_CDCCS4(_subtype,_d0) { 4, 0x24, _subtype, _d0 }
198198

199199
#ifndef DOXYGEN_ARD
200-
// the following would confuse doxygen documentation tool, so skip in that case for autodoc build
200+
// the following would confuse the Doxygen documentation tool, so skip in that case for autodoc build
201201
_Pragma("pack()")
202202

203203
#define WEAK __attribute__ ((weak))
@@ -206,25 +206,25 @@ _Pragma("pack()")
206206

207207
/**
208208
Concrete MIDI implementation of a PluggableUSBModule
209-
By default, will define one midi in and one midi out enpoints.
209+
By default, will define one MIDI in and one MIDI out endpoints.
210210
*/
211211
class MIDI_ : public PluggableUSBModule
212212
{
213213
// private:
214214
// RingBuffer *_midi_rx_buffer;
215215
private:
216-
void accept(void); ///< Accepts a midi packet, \see MIDI_::read()
216+
void accept(void); ///< Accepts a MIDI packet, \see MIDI_::read()
217217
EPTYPE_DESCRIPTOR_SIZE epType[2]; ///< Container that defines the two bulk MIDI IN/OUT endpoints types
218218

219219
protected:
220220
// Implementation of the PUSBListNode
221221

222-
/// Creates a MIDIDescriptor midi interface and sollicit USBDevice to send control to it.
222+
/// Creates a MIDIDescriptor MIDI interface and solicits USBDevice to send control to it.
223223
/// \see USBDevice::SendControl()
224224
int getInterface(uint8_t* interfaceNum);
225225
/// Current implementation just returns 0
226226
int getDescriptor(USBSetup& setup);
227-
/// Optional interface usb setup callback, current implementation returns false
227+
/// Optional interface USB setup callback, current implementation returns false
228228
bool setup(USBSetup& setup);
229229
/// MIDI Device short name, defaults to "MIDI" and returns a length of 4 chars
230230
uint8_t getShortName(char* name);
@@ -236,7 +236,7 @@ class MIDI_ : public PluggableUSBModule
236236
uint32_t available(void);
237237
/// Reads a new MIDI message from USB
238238
midiEventPacket_t read(void);
239-
/// Flushes TX midi channel
239+
/// Flushes TX MIDI channel
240240
void flush(void);
241241
/// Sends a MIDI message to USB
242242
void sendMIDI(midiEventPacket_t event);

src/pitchToNote.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
#define pitchB0 23
9595
#define pitchB0b 22
9696
#define pitchA0 21
97-
/// Full 88 key range note pitch high to low midi byte value mapping array
97+
/// Full 88 key range note pitch high to low MIDI byte value mapping array
9898
const int notePitch[] = {pitchC8,
9999
pitchB7, pitchB7b, pitchA7, pitchA7b, pitchG7, pitchG7b, pitchF7, pitchE7, pitchE7b, pitchD7, pitchD7b, pitchC7,
100100
pitchB6, pitchB6b, pitchA6, pitchA6b, pitchG6, pitchG6b, pitchF6, pitchE6, pitchE6b, pitchD6, pitchD6b, pitchC6,

0 commit comments

Comments
 (0)