Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-04-07 10:02:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc review

Browse source
This commit is contained in:
David Rowe 2019-05-03 17:07:14 +12:00
parent e7eaa7815c
commit 8458d746cd
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
libraries/midi/src/Midi.cpp
View file

@ -266,7 +266,7 @@ void Midi::MidiCleanup() {
* <p><strong>Warning:</strong> The <code>status</code> property is NOT a MIDI status value.</p>
* @typedef {object} Midi.MidiMessage
* @property {number} device - Device number.
* @property {Midi.RawMidiMessage} raw - Raw MIDI messag.
* @property {Midi.RawMidiMessage} raw - Raw MIDI message.
* @property {number} status - Channel + status. <em>Legacy value.</em>
* @property {number} channel - Channel: <code>1</code> &ndash; <code>16</code>.
* @property {number} type - Status: {@link Midi.MidiStatus}; <code>8</code> &ndash; <code>15</code>.

12
libraries/midi/src/Midi.h
View file

@ -143,7 +143,7 @@ public slots:
* Unblocks a MIDI device's input or output.
* @function Midi.unblockMidiDevice
* @param {string} name- The name of the MIDI device to unblock.
* @param {boolean} output - <code>true</code> to block the device's output, <code>false</code> to block its input.
* @param {boolean} output - <code>true</code> to unblock the device's output, <code>false</code> to unblock its input.
*/
Q_INVOKABLE void unblockMidiDevice(QString name, bool output);
@ -175,28 +175,28 @@ public slots:
Q_INVOKABLE void typeNoteOffEnable(bool enable);
/**jsdoc
* Enables or disabled note on events.
* Enables or disables note on events.
* @function Midi.typeNoteOnEnable
* @param {boolean} enable - <code>true</code> to enable, <code>false</code> to disable.
*/
Q_INVOKABLE void typeNoteOnEnable(bool enable);
/**jsdoc
* Enables or disabled ply key pressure events.
* Enables or disables poly key pressure events.
* @function Midi.typePolyKeyPressureEnable
* @param {boolean} enable - <code>true</code> to enable, <code>false</code> to disable.
*/
Q_INVOKABLE void typePolyKeyPressureEnable(bool enable);
/**jsdoc
* Enables or disabled control change events.
* Enables or disables control change events.
* @function Midi.typeControlChangeEnable
* @param {boolean} enable - <code>true</code> to enable, <code>false</code> to disable.
*/
Q_INVOKABLE void typeControlChangeEnable(bool enable);
/**jsdoc
* Enables or disabled program change events.
* Enables or disables program change events.
* @function Midi.typeProgramChangeEnable
* @param {boolean} enable - <code>true</code> to enable, <code>false</code> to disable.
*/
@ -210,7 +210,7 @@ public slots:
Q_INVOKABLE void typeChanPressureEnable(bool enable);
/**jsdoc
* Enables or disabled pitch bend events.
* Enables or disables pitch bend events.
* @function Midi.typePitchBendEnable
* @param {boolean} enable - <code>true</code> to enable, <code>false</code> to disable.
*/