Use custom \setting{} alias to link to fluid settings

doc/Doxyfile

@@ -27,6 +27,7 @@ TAB_SIZE = 8
 ALIASES += startlifecycle{1}="\name Lifecycle Functions for \1\n@{"
 ALIASES += startlifecycle="\name Lifecycle Functions\n@{"
 ALIASES += endlifecycle="@}"
+ALIASES += setting{1}="\ref settings_\1"
 OPTIMIZE_OUTPUT_FOR_C = YES
 OPTIMIZE_OUTPUT_JAVA = NO
 OPTIMIZE_FOR_FORTRAN = NO

doc/Doxyfile.cmake

@@ -27,6 +27,7 @@ TAB_SIZE = 8
 ALIASES += startlifecycle{1}="\name Lifecycle Functions for \1\n@{"
 ALIASES += startlifecycle="\name Lifecycle Functions\n@{"
 ALIASES += endlifecycle="@}"
+ALIASES += setting{1}="\ref settings_\1"
 OPTIMIZE_OUTPUT_FOR_C = YES
 OPTIMIZE_OUTPUT_JAVA = NO
 OPTIMIZE_FOR_FORTRAN = NO

doc/recent_changes.txt

@@ -24,7 +24,7 @@
 \section NewIn2_1_0 What's new in 2.1.0?
 
 - <span style="color:red">refrain from using fluid_synth_set_sample_rate()</span>
-- \ref settings_synth_sample-rate is no real-time setting anymore, see note about fluid_synth_set_sample_rate()
+- \setting{synth_sample-rate} is no real-time setting anymore, see note about fluid_synth_set_sample_rate()
 - new reverb engine
 - chorus is now stereophonic
 - smallest allowed chorus speed is now 0.1 Hz (previously 0.29 Hz)
@@ -49,7 +49,7 @@
 \section NewIn2_0_5 What's new in 2.0.5?
 
 - fluid_synth_process() omitted audio samples when called with arbitrary sample counts that were not a multiple of fluid_synth_get_internal_bufsize()
-- fluid_synth_sfunload() was not releasing sample buffers of SoundFont3 files if \ref settings_synth_dynamic-sample-loading was set to FALSE
+- fluid_synth_sfunload() was not releasing sample buffers of SoundFont3 files if \setting{synth_dynamic-sample-loading} was set to FALSE
 
 \section NewIn2_0_3 What's new in 2.0.3?
 
@@ -72,7 +72,7 @@ FluidSynths major version was bumped. The API was reworked, deprecated functions
 - fluid_settings_setstr() cannot be used to set integer (toggle) settings with "yes" or "no" values anymore. Use fluid_settings_setint() instead, for example: <br /><code>fluid_settings_setint(settings, "synth.reverb.active", 0)</code> instead of <code>fluid_settings_setstr(settings, "synth.reverb.active", "no")</code>
 - <span style="text-decoration:line-through;">explicit client unregistering is required for fluid_sequencer_register_client() and fluid_sequencer_register_fluidsynth()</span> (since fluidsynth 2.1.1 not required anymore, but still recommend)
 - all public functions consistently receive signed integers for soundfont ids, bank and program numbers
-- use unique device names for the "audio.portaudio.device" setting
+- use unique device names for the \setting{audio_portaudio_device} setting
 - fluid_synth_process() received a new more flexible implementation, but now requires zeroed-out sample buffers
 
 <strong>Other changes in FluidSynth 2.0.0 concerning developers:</strong>
@@ -89,14 +89,14 @@ FluidSynths major version was bumped. The API was reworked, deprecated functions
 
 <strong>New Features and API additions:</strong>
 
-- add \ref settings_midi_autoconnect a setting for automatically connecting fluidsynth to available MIDI input ports
+- add \setting{midi_autoconnect} a setting for automatically connecting fluidsynth to available MIDI input ports
-- add \ref settings_synth_overflow_important and \ref settings_synth_overflow_important-channels settings to take midi channels during overflow calculation into account that are considered to be "important"
+- add \setting{synth_overflow_important} and \setting{synth_overflow_important-channels} settings to take midi channels during overflow calculation into account that are considered to be "important"
-- add \ref settings_synth_dynamic-sample-loading a setting for enabling on demand sample loading
+- add \setting{synth_dynamic-sample-loading} a setting for enabling on demand sample loading
 - add support for polyphonic key pressure events, see fluid_event_key_pressure() and fluid_synth_key_pressure()
 - add fluid_synth_add_default_mod() and fluid_synth_remove_default_mod() for manipulating default modulators
 - add individual reverb setters: fluid_synth_set_reverb_roomsize(), fluid_synth_set_reverb_damp(), fluid_synth_set_reverb_width(), fluid_synth_set_reverb_level()
 - add individual chorus setters: fluid_synth_set_chorus_nr(), fluid_synth_set_chorus_level(), fluid_synth_set_chorus_speed(), fluid_synth_set_chorus_depth(), fluid_synth_set_chorus_type()
-- add realtime settings for \ref settings_synth_reverb_damp and \ref settings_synth_chorus_depth parameters
+- add realtime settings for \setting{synth_reverb_damp} and \setting{synth_chorus_depth} parameters
 - add seek support to midi-player, see fluid_player_seek()
 - expose functions to manipulate the ladspa effects unit (see ladspa.h)
 - add support for text and lyrics midi events, see fluid_midi_event_set_lyrics() and fluid_midi_event_set_text()

doc/usage/audio_driver.txt

@@ -40,7 +40,7 @@ with fluid_settings_setstr(). In most cases, the default driver should work
 out of the box. 
 
 Additional options that define the audio quality and latency are
-"audio.sample-format", "audio.period-size", and "audio.periods". The details
+\setting{audio_sample-format}, \setting{audio_period-size}, and \setting{audio_periods}. The details
 are described later. 
 
 You create the audio driver with the new_fluid_audio_driver() function. This
@@ -67,11 +67,11 @@ driver creates a separate thread that uses the synthesizer object to generate
 the audio.
  
 There are a number of general audio driver settings. The audio.driver
-settings define the audio subsystem that will be used. The audio.periods and
+settings define the audio subsystem that will be used. The \setting{audio_periods} and
-audio.period-size settings define the latency and robustness against
+\setting{audio_period-size} settings define the latency and robustness against
 scheduling delays. There are additional settings for the audio subsystems
 used. For a full list of available <strong>audio driver settings</strong>,
-please refer to the \ref settings_audio documentation.
+please refer to the \setting{audio} documentation.
 
 <strong>*Note:</strong> In order to use sdl2 as audio driver, the application
 is responsible for initializing SDL (e.g. with SDL_Init()). This must be done

doc/usage/creating_settings.txt

@@ -4,7 +4,7 @@
 
 Before you can use the synthesizer, you have to create a settings object. The settings objects is used by many components of the FluidSynth library. It gives a unified API to set the parameters of the audio drivers, the midi drivers, the synthesizer, and so forth. A number of default settings are defined by the current implementation.
 
-All settings have a name that follows the "dotted-name" notation. For example, "synth.polyphony" refers to the number of voices (polyphony) allocated by the synthesizer. The settings also have a type. There are currently three types: strings, numbers (double floats), and integers. You can change the values of a setting using the fluid_settings_setstr(), fluid_settings_setnum(), and fluid_settings_setint() functions. For example: 
+All settings have a name that follows the "dotted-name" notation. For example, \setting{synth_polyphony} refers to the number of voices (polyphony) allocated by the synthesizer. The settings also have a type. There are currently three types: strings, numbers (double floats), and integers. You can change the values of a setting using the fluid_settings_setstr(), fluid_settings_setnum(), and fluid_settings_setint() functions. For example: 
 
 \code
 #include <fluidsynth.h>

doc/usage/creating_synth.txt

@@ -24,6 +24,6 @@ int main(int argc, char** argv)
 \endcode
 
 For a full list of available <strong>synthesizer settings</strong>, please
-refer to the \ref settings_synth documentation.
+refer to the \setting{synth} documentation.
 
 */

doc/usage/file_renderer.txt

@@ -54,7 +54,7 @@ delete_fluid_settings(settings);
 \endcode
 
 Various output files types are supported, if compiled with libsndfile. Those
-can be specified via the \c settings object as well. Refer to the \ref
+can be specified via the \c settings object as well. Refer to the
-settings_audio documentation for more \c audio.file\.\* options.
+\setting{audio} documentation for more \c audio.file\.\* options.
 
 */

doc/usage/midi_player.txt

@@ -50,6 +50,6 @@ int main(int argc, char** argv)
 
 
 A list of available <strong>MIDI player settings</strong> can be found in the
-\ref settings_player documentation.
+\setting{player} documentation.
 
 */

doc/usage/realtime_midi.txt

@@ -38,10 +38,9 @@ int main(int argc, char** argv)
 }
 \endcode
 
-There are a number of general MIDI driver settings. The midi.driver setting
+There are a number of general MIDI driver settings. The \setting{midi_driver} setting
 defines the MIDI subsystem that will be used. There are additional settings
 for the MIDI subsystems used. For a full list of available
-<strong>midi driver settings</strong>, please refer to the \ref settings_midi
+<strong>midi driver settings</strong>, please refer to the \setting{midi} documentation.
-documentation.
 
 */