exclude private headers from public API doc generation

This commit is contained in:
derselbst 2017-11-30 12:55:20 +01:00
parent 5bc1f57ec5
commit 01040409ba
10 changed files with 14 additions and 14 deletions

View file

@ -88,7 +88,7 @@ FILE_PATTERNS = *.c *.h
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = fluid_*.h
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = ../doc
EXAMPLE_PATTERNS = *.c

View file

@ -88,7 +88,7 @@ FILE_PATTERNS = *.c *.h
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = fluid_*.h
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/doc
EXAMPLE_PATTERNS = *.c

View file

@ -87,7 +87,7 @@ Changes in FluidSynth 2.0.0 concerning developers:
- remove obsolete "audio.[out|in]put-channels" settings
- remove unimplemented "synth.dump" setting
- remove fluid_synth_set_gen2(), fluid_synth_set_gen() now behaves as fluid_synth_set_gen2()
- remove struct fluid_mod_t from public API, use the getters and setters of mod.h instead
- remove struct _fluid_mod_t from public API, use the getters and setters of mod.h instead
- remove struct _fluid_gen_t, fluid_gen_set_default_values() and enum fluid_gen_flags from public API
- remove macros fluid_sfont_get_id() and fluid_sample_refcount() from public API
<br /><br />

View file

@ -263,7 +263,7 @@ int fluid_track_send_events(fluid_track_t* track,
#define fluid_track_eot(track) ((track)->cur == NULL)
/**
/*
* fluid_playlist_item
* Used as the `data' elements of the fluid_player.playlist.
* Represents either a filename or a pre-loaded memory buffer.

View file

@ -48,7 +48,7 @@ enum fluid_loop {
FLUID_LOOP_UNTIL_RELEASE = 3
};
/**
/*
* rvoice ticks-based parameters
* These parameters must be updated even if the voice is currently quiet.
*/
@ -77,7 +77,7 @@ struct _fluid_rvoice_envlfo_t
fluid_real_t viblfo_to_pitch;
};
/**
/*
* rvoice parameters needed for dsp interpolation
*/
struct _fluid_rvoice_dsp_t
@ -129,7 +129,7 @@ struct _fluid_rvoice_dsp_t
ever add surround positioning, or stereo reverb/chorus */
#define FLUID_RVOICE_MAX_BUFS (4)
/**
/*
* rvoice mixer-related parameters
*/
struct _fluid_rvoice_buffers_t
@ -142,7 +142,7 @@ struct _fluid_rvoice_buffers_t
};
/**
/*
* Hard real-time parameters needed to synthesize a voice
*/
struct _fluid_rvoice_t

View file

@ -42,7 +42,7 @@ struct _fluid_rvoice_event_t {
void fluid_rvoice_event_dispatch(fluid_rvoice_event_t* event);
/**
/*
* Bridge between the renderer thread and the midi state thread.
* If is_threadsafe is true, that means fluid_rvoice_eventhandler_fetch_all
* can be called in parallell with fluid_rvoice_eventhandler_push/flush

View file

@ -33,7 +33,7 @@ typedef struct _fluid_gen_info_t {
float def; /* The default value (cfr. fluid_gen_set_default_values()) */
} fluid_gen_info_t;
/**
/*
* SoundFont generator structure.
*/
typedef struct _fluid_gen_t
@ -44,7 +44,7 @@ typedef struct _fluid_gen_t
double nrpn; /**< Change by NRPN messages */
} fluid_gen_t;
/**
/*
* Enum value for 'flags' field of #fluid_gen_t (not really flags).
*/
enum fluid_gen_flags

View file

@ -24,7 +24,7 @@
#include "fluidsynth_priv.h"
#include "fluid_conv.h"
/**
/*
* Modulator structure. See SoundFont 2.04 PDF section 8.2.
*/
struct _fluid_mod_t

View file

@ -78,7 +78,7 @@ enum fluid_synth_status
#define SYNTH_REVERB_CHANNEL 0
#define SYNTH_CHORUS_CHANNEL 1
/**
/*
* Structure used for sfont_info field in #fluid_synth_t for each loaded
* SoundFont with the SoundFont instance and additional fields.
*/

View file

@ -23,7 +23,7 @@
#include "fluid_sys.h"
/**
/*
* Lockless event queue instance.
*/
struct _fluid_ringbuffer_t