deprecate some enum values

addressing #186
FluidSynth · Sep 4, 2017 · e3232e3 · e3232e3
1 parent c407f20
commit e3232e3
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 3 deletions.
diff --git a/doc/fluidsynth-v11-devdoc.txt b/doc/fluidsynth-v11-devdoc.txt
@@ -76,6 +76,7 @@ Changes in FluidSynth 1.1.7 concerning developers:
 - reverb and chorus are routed to distinct buffers in fluid_synth_nwrite_float()
 - vorbis-compressed sf3 sound fonts are supported
 - the following getters have been added: fluid_voice_is_on(), fluid_voice_is_sustained(), fluid_voice_is_sostenuto(), fluid_voice_get_channel(), fluid_voice_get_key(), fluid_voice_get_actual_key(), fluid_voice_get_velocity(), fluid_voice_get_actual_velocity(), fluid_player_get_current_tick(), fluid_player_get_total_ticks(), fluid_player_get_bpm(), fluid_player_get_midi_tempo()
+- the following enum values have been deprecated: \c FLUID_SEQ_LASTEVENT, \c GEN_LAST, \c LAST_LOG_LEVEL
 
 - For a full list of bug fixes, see
   https://github.com/FluidSynth/fluidsynth/wiki/ChangeLog#fluidsynth-117

diff --git a/include/fluidsynth/event.h b/include/fluidsynth/event.h
@@ -58,7 +58,7 @@ enum fluid_seq_event_type {
   FLUID_SEQ_CHANNELPRESSURE,    /**< Channel aftertouch event @since 1.1.0 */
   FLUID_SEQ_SYSTEMRESET,        /**< System reset event @since 1.1.0 */
   FLUID_SEQ_UNREGISTERING,      /**< Called when a sequencer client is being unregistered. @since 1.1.0 */
-  FLUID_SEQ_LASTEVENT		/**< Defines the count of event enums */
+  FLUID_SEQ_LASTEVENT		/**< Defines the count of event enums @deprecated As of 1.1.7 this enum value is deprecated and will be removed in a future release, because it prevents adding new enum values without breaking ABI compatibility. */
 };
 
 #define FLUID_SEQ_PITCHWHHELSENS        FLUID_SEQ_PITCHWHEELSENS        /**< Old deprecated misspelling of #FLUID_SEQ_PITCHWHEELSENS */

diff --git a/include/fluidsynth/gen.h b/include/fluidsynth/gen.h
@@ -99,7 +99,7 @@ enum fluid_gen_type {
    * is used, however, as the destination for the default pitch wheel
    * modulator. */
   GEN_PITCH,			/**< Pitch (NOTE: Not a real SoundFont generator) */
-  GEN_LAST			/**< Value defines the count of generators (#fluid_gen_type) */
+  GEN_LAST			/**< Value defines the count of generators (#fluid_gen_type) @deprecated As of 1.1.7 this enum value is deprecated and will be removed in a future release, because it prevents adding new enum values without breaking ABI compatibility. */
 };
 
 

diff --git a/include/fluidsynth/log.h b/include/fluidsynth/log.h
@@ -58,7 +58,7 @@ enum fluid_log_level {
   FLUID_WARN,    /**< Warning */
   FLUID_INFO,    /**< Verbose informational messages */
   FLUID_DBG,     /**< Debugging messages */
-  LAST_LOG_LEVEL
+  LAST_LOG_LEVEL /**< @deprecated As of 1.1.7 this enum value is deprecated and will be removed in a future release, because it prevents adding new enum values without breaking ABI compatibility. */
 };
 
 /**