From 84124e3230e64ab137631cc159daa0a577321f62 Mon Sep 17 00:00:00 2001
From: derselbst <tom.mbrt@googlemail.com>
Date: Sun, 10 Dec 2017 17:31:11 +0100
Subject: [PATCH] doc the DOCMEs

---
 include/fluidsynth/event.h |  2 +-
 src/synth/fluid_event.c    | 18 +++++++++---------
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/include/fluidsynth/event.h b/include/fluidsynth/event.h
index 374bdb53..1f601074 100644
--- a/include/fluidsynth/event.h
+++ b/include/fluidsynth/event.h
@@ -54,7 +54,7 @@ enum fluid_seq_event_type {
   FLUID_SEQ_REVERBSEND,		/**< Reverb send set event */
   FLUID_SEQ_CHORUSSEND,		/**< Chorus send set event */
   FLUID_SEQ_TIMER,		/**< Timer event (useful for giving a callback at a certain time) */
-  FLUID_SEQ_ANYCONTROLCHANGE,	/**< DOCME (used for remove_events only) */
+  FLUID_SEQ_ANYCONTROLCHANGE,	/**< Any control change message (only internally used for remove_events) */
   FLUID_SEQ_CHANNELPRESSURE,    /**< Channel aftertouch event @since 1.1.0 */
   FLUID_SEQ_KEYPRESSURE,        /**< Polyphonic aftertouch event @since 2.0.0 */
   FLUID_SEQ_SYSTEMRESET,        /**< System reset event @since 1.1.0 */
diff --git a/src/synth/fluid_event.c b/src/synth/fluid_event.c
index 5bc99adc..2161e6a9 100644
--- a/src/synth/fluid_event.c
+++ b/src/synth/fluid_event.c
@@ -117,7 +117,7 @@ fluid_event_set_dest(fluid_event_t* evt, fluid_seq_id_t dest)
 /**
  * Set a sequencer event to be a timer event.
  * @param evt Sequencer event structure
- * @param data DOCME
+ * @param data User supplied data pointer
  */
 void
 fluid_event_timer(fluid_event_t* evt, void* data)
@@ -162,7 +162,7 @@ fluid_event_noteoff(fluid_event_t* evt, int channel, short key)
  * @param channel MIDI channel number
  * @param key MIDI note number (0-127)
  * @param vel MIDI velocity value (0-127)
- * @param duration Duration of note (DOCME units?)
+ * @param duration Duration of note in the time scale used by the sequencer (by default milliseconds)
  */
 void
 fluid_event_note(fluid_event_t* evt, int channel, short key, short vel, unsigned int duration)
@@ -246,10 +246,9 @@ fluid_event_program_select(fluid_event_t* evt, int channel,
 }
 
 /**
- * Set a sequencer event to be an any control change event.
+ * Set a sequencer event to be an any control change event (for internal use).
  * @param evt Sequencer event structure
  * @param channel MIDI channel number
- * DOCME
  */
 void
 fluid_event_any_control_change(fluid_event_t* evt, int channel)
@@ -278,7 +277,7 @@ fluid_event_pitch_bend(fluid_event_t* evt, int channel, int pitch)
  * Set a sequencer event to be a pitch wheel sensitivity event.
  * @param evt Sequencer event structure
  * @param channel MIDI channel number
- * @param value MIDI pitch wheel sensitivity value (DOCME units?)
+ * @param value MIDI pitch wheel sensitivity value in semitones
  */
 void
 fluid_event_pitch_wheelsens(fluid_event_t* evt, int channel, short value)
@@ -325,7 +324,7 @@ fluid_event_sustain(fluid_event_t* evt, int channel, short val)
  * @param evt Sequencer event structure
  * @param channel MIDI channel number
  * @param control MIDI control number (0-127)
- * @param val MIDI control value (0-16383 DOCME is that true?)
+ * @param val MIDI control value (0-127)
  */
 void
 fluid_event_control_change(fluid_event_t* evt, int channel, short control, short val)
@@ -478,9 +477,10 @@ int fluid_event_get_type(fluid_event_t* evt)
 }
 
 /**
+ * @internal
  * Get the time field from a sequencer event structure.
  * @param evt Sequencer event structure
- * @return Time value (DOCME units?)
+ * @return Time value
  */
 unsigned int fluid_event_get_time(fluid_event_t* evt)
 {
@@ -510,7 +510,7 @@ fluid_seq_id_t fluid_event_get_dest(fluid_event_t* evt)
 /**
  * Get the MIDI channel field from a sequencer event structure.
  * @param evt Sequencer event structure
- * @return MIDI channel number (DOCME 0-15 or more?)
+ * @return MIDI zero-based channel number
  */
 int fluid_event_get_channel(fluid_event_t* evt)
 {
@@ -579,7 +579,7 @@ void* fluid_event_get_data(fluid_event_t* evt)
 /**
  * Get the duration field from a sequencer event structure.
  * @param evt Sequencer event structure
- * @return Note duration value (DOCME units?)
+ * @return Note duration value in the time scale used by the sequencer (by default milliseconds)
  *
  * Used by the #FLUID_SEQ_NOTE event type.
  */