From 7a8c90e253deb368d322a24c7a69c4ab237af8fa Mon Sep 17 00:00:00 2001 From: jules Date: Thu, 28 Aug 2014 17:20:25 +0100 Subject: [PATCH] Improved some MidiBuffer comments --- modules/juce_audio_basics/midi/juce_MidiBuffer.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/modules/juce_audio_basics/midi/juce_MidiBuffer.h b/modules/juce_audio_basics/midi/juce_MidiBuffer.h index 7dfc4588ba..ecbc56a212 100644 --- a/modules/juce_audio_basics/midi/juce_MidiBuffer.h +++ b/modules/juce_audio_basics/midi/juce_MidiBuffer.h @@ -186,9 +186,10 @@ public: /** Retrieves a copy of the next event from the buffer. - @param result on return, this will be the message (the MidiMessage's timestamp - is not set) - @param samplePosition on return, this will be the position of the event + @param result on return, this will be the message. The MidiMessage's timestamp + is set to the same value as samplePosition. + @param samplePosition on return, this will be the position of the event, as a + sample index in the buffer @returns true if an event was found, or false if the iterator has reached the end of the buffer */ @@ -203,7 +204,8 @@ public: temporarily until the MidiBuffer is altered. @param numBytesOfMidiData on return, this is the number of bytes of data used by the midi message - @param samplePosition on return, this will be the position of the event + @param samplePosition on return, this will be the position of the event, as a + sample index in the buffer @returns true if an event was found, or false if the iterator has reached the end of the buffer */