Merge pull request #262 from FluidSynth/doc-2.0

cleanup API doc

doc/Doxyfile

@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING = UTF-8
 PROJECT_NAME = libfluidsynth
-PROJECT_NUMBER = 1.1.8
+PROJECT_NUMBER = 2.0.0ALPHA
 OUTPUT_DIRECTORY = api
 CREATE_SUBDIRS = NO
 OUTPUT_LANGUAGE = English

doc/fluidsynth-v11-devdoc.txt

@@ -1,5 +1,5 @@
 /*! 
-\mainpage FluidSynth 1.1 Developer Documentation 
+\mainpage FluidSynth 2.0 Developer Documentation 
 \author Peter Hanappe
 \author Conrad Berhörster
 \author Antoine Schmitt
@@ -8,7 +8,7 @@
 \author David Henningsson
 \author Tom Moebert
 \author Copyright © 2003-2017 Peter Hanappe, Conrad Berhörster, Antoine Schmitt, Pedro López-Cabanillas, Josh Green, David Henningsson, Tom Moebert
-\version Revision 1.1.8
+\version Revision 2.0.0ALPHA
 \date 2017-10-14
 
 All the source code examples in this document are in the public domain; you can use them as you please. This document is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ . The FluidSynth library is distributed under the GNU Lesser General Public License. A copy of the GNU Lesser General Public License is contained in the FluidSynth package; if not, visit http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt or write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
@@ -21,7 +21,7 @@ All the source code examples in this document are in the public domain; you can
 
 - \ref Disclaimer
 - \ref Introduction
-- \ref NewIn@NEXT_RELEASE@
+- \ref NewIn2_0_0
 - \ref NewIn1_1_8
 - \ref NewIn1_1_7
 - \ref NewIn1_1_6
@@ -67,11 +67,11 @@ What is FluidSynth?
 
 - FluidSynth is open source, in active development. For more details, take a look at http://www.fluidsynth.org
 
-\section NewIn@NEXT_RELEASE@ Whats new in @NEXT_RELEASE@?
+\section NewIn2_0_0 Whats new in 2.0.0?
 
 FluidSynths SOVERSION was bumped. The API was reworked, deprecated functions were removed. Functions that were doing (nearly) the same were fused together.
 
-Changes in FluidSynth @NEXT_RELEASE@ concerning developers:
+Changes in FluidSynth 2.0.0 concerning developers:
 
 - remove deprecated fluid_synth_get_program() and fluid_synth_get_channel_preset(), use fluid_synth_get_channel_info() instead
 - remove deprecated fluid_settings_getstr()

include/fluidsynth/event.h

@@ -56,7 +56,7 @@ enum fluid_seq_event_type {
   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_CHANNELPRESSURE,    /**< Channel aftertouch event @since 1.1.0 */
-  FLUID_SEQ_KEYPRESSURE,        /**< Polyphonic aftertouch event @since @NEXT_RELEASE@ */
+  FLUID_SEQ_KEYPRESSURE,        /**< Polyphonic aftertouch event @since 2.0.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 @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. */

include/fluidsynth/synth.h

@@ -49,7 +49,7 @@ extern "C" {
 
 /**
  * Channel information structure for fluid_synth_get_channel_info().
- * @since @NEXT_RELEASE@
+ * @since 2.0.0
  */
 struct _fluid_synth_channel_info_t
 {

src/synth/fluid_event.c

@@ -438,7 +438,7 @@ fluid_event_channel_pressure(fluid_event_t* evt, int channel, short val)
  * @param channel MIDI channel number
  * @param key MIDI note number (0-127)
  * @param val Aftertouch amount (0-127)
- * @since @NEXT_RELEASE@
+ * @since 2.0.0
  */
 void
 fluid_event_key_pressure(fluid_event_t* evt, int channel, short key, short val)

src/synth/fluid_synth.c

@@ -1834,7 +1834,7 @@ fluid_synth_update_channel_pressure_LOCAL(fluid_synth_t* synth, int chan)
  * @param key MIDI key number (0-127)
  * @param val MIDI key pressure value (0-127)
  * @return FLUID_OK on success, FLUID_FAILED otherwise
- * @since @NEXT_RELEASE@
+ * @since 2.0.0
  */
 int
 fluid_synth_key_pressure(fluid_synth_t* synth, int chan, int key, int val)
@@ -4974,7 +4974,7 @@ fluid_synth_get_settings(fluid_synth_t* synth)
  *   TRUE to take the value as a 0.0-1.0 range and apply it to the valid
  *   generator effect range (scaled and shifted as necessary).
  * @return FLUID_OK on success, FLUID_FAILED otherwise
- * @since @NEXT_RELEASE@
+ * @since 2.0.0
  *
  * This function allows for setting all effect parameters in real time on a
  * MIDI channel.  Setting absolute to non-zero will cause the value to override