Misc. JSDoc fixes

This commit is contained in:
David Rowe 2019-04-25 22:01:03 +12:00
parent 62cf42732b
commit e7eaa7815c
2 changed files with 3 additions and 3 deletions

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

View file

@ -59,7 +59,7 @@ signals:
/**jsdoc /**jsdoc
* Triggered when a connected device sends an output. * Triggered when a connected device sends an output.
* @function Midi.midiNote * @function Midi.midiNote
* @param {MidiMessage} message - The MIDI message. * @param {Midi.MidiMessage} message - The MIDI message.
* @returns {Signal} * @returns {Signal}
* @deprecated This signal is deprecated and will be removed. Use {@link Midi.midiMessage|midiMessage} instead. * @deprecated This signal is deprecated and will be removed. Use {@link Midi.midiMessage|midiMessage} instead.
*/ */
@ -68,7 +68,7 @@ signals:
/**jsdoc /**jsdoc
* Triggered when a connected device sends an output. * Triggered when a connected device sends an output.
* @function Midi.midiMessage * @function Midi.midiMessage
* @param {MidiMessage} message - The MIDI message. * @param {Midi.MidiMessage} message - The MIDI message.
* @returns {Signal} * @returns {Signal}
*/ */
void midiMessage(QVariantMap eventData); void midiMessage(QVariantMap eventData);