From ee54b13d6d5bf14948aea6d2f55abc2919c038d1 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 30 Sep 2019 05:33:44 +0200 Subject: Fix some more doxygen warnings --- libs/ardour/ardour/dsp_filter.h | 4 ++-- libs/ardour/ardour/fluid_synth.h | 1 + libs/ardour/ardour/lua_api.h | 13 +++++++------ libs/ardour/ardour/port_manager.h | 3 +-- libs/ardour/ardour/processor.h | 13 ++++++++++--- libs/ardour/ardour/tempo.h | 17 +++++++++-------- 6 files changed, 30 insertions(+), 21 deletions(-) (limited to 'libs/ardour/ardour') diff --git a/libs/ardour/ardour/dsp_filter.h b/libs/ardour/ardour/dsp_filter.h index 1f13cceb61..e557c39808 100644 --- a/libs/ardour/ardour/dsp_filter.h +++ b/libs/ardour/ardour/dsp_filter.h @@ -192,7 +192,7 @@ namespace ARDOUR { namespace DSP { * * @param data pointer to control-data array * @param val target value - * @param array length + * @param n_samples array length */ void ctrl (float *data, const float val, const uint32_t n_samples); /** update filter cut-off frequency @@ -282,7 +282,7 @@ namespace ARDOUR { namespace DSP { /** query * @param bin the frequency bin 0 .. window_size / 2 - * @param norm gain factor (set equal to @bin for 1/f normalization) + * @param norm gain factor (set equal to \param bin for 1/f normalization) * @return signal power at given bin (in dBFS) */ float power_at_bin (const uint32_t bin, const float norm = 1.f) const; diff --git a/libs/ardour/ardour/fluid_synth.h b/libs/ardour/ardour/fluid_synth.h index 2b9af71a91..e37a27419e 100644 --- a/libs/ardour/ardour/fluid_synth.h +++ b/libs/ardour/ardour/fluid_synth.h @@ -34,6 +34,7 @@ namespace ARDOUR { /** instantiate a Synth * * @param samplerate samplerate + * @param polyphony polyphony */ FluidSynth (float samplerate, int polyphony = 32); ~FluidSynth (); diff --git a/libs/ardour/ardour/lua_api.h b/libs/ardour/ardour/lua_api.h index 9f5e0d0aa1..1407b3cd3b 100644 --- a/libs/ardour/ardour/lua_api.h +++ b/libs/ardour/ardour/lua_api.h @@ -81,6 +81,7 @@ namespace ARDOUR { namespace LuaAPI { * @param s Session Handle * @param id Plugin Name, ID or URI * @param type Plugin Type + * @param preset name of plugin-preset to load, leave empty "" to not load any preset after instantiation * @returns Processor or nil */ boost::shared_ptr new_plugin (ARDOUR::Session *s, const std::string& id, ARDOUR::PluginType type, const std::string& preset = ""); @@ -92,7 +93,7 @@ namespace ARDOUR { namespace LuaAPI { * @param value value to set * @returns true on success, false on error or out-of-bounds value */ - bool set_processor_param (boost::shared_ptr proc, uint32_t which, float val); + bool set_processor_param (boost::shared_ptr proc, uint32_t which, float value); /** get a plugin control parameter value * @@ -116,16 +117,16 @@ namespace ARDOUR { namespace LuaAPI { * * This is a wrapper around set_processor_param which looks up the Processor by plugin-insert. * - * @param proc Plugin-Insert + * @param pi Plugin-Insert * @param which control-input to set (starting at 0) * @param value value to set * @returns true on success, false on error or out-of-bounds value */ - bool set_plugin_insert_param (boost::shared_ptr pi, uint32_t which, float val); + bool set_plugin_insert_param (boost::shared_ptr pi, uint32_t which, float value); /** get a plugin control parameter value * - * @param proc Plugin-Insert + * @param pi Plugin-Insert * @param which control port to query (starting at 0, including ports of type input and output) * @param ok boolean variable contains true or false after call returned. to be checked by caller before using value. * @returns value @@ -250,12 +251,12 @@ namespace ARDOUR { namespace LuaAPI { * * If the plugin is not yet initialized, initialize() is called. * - * if @cb is not nil, it is called with the immediate + * if \param fn is not nil, it is called with the immediate * Vamp::Plugin::Features on every process call. * * @param r readable * @param channel channel to process - * @param fn lua callback function + * @param fn lua callback function or nil * @return 0 on success */ int analyze (boost::shared_ptr r, uint32_t channel, luabridge::LuaRef fn); diff --git a/libs/ardour/ardour/port_manager.h b/libs/ardour/ardour/port_manager.h index 46e6dc77ad..a991d4fafd 100644 --- a/libs/ardour/ardour/port_manager.h +++ b/libs/ardour/ardour/port_manager.h @@ -189,8 +189,7 @@ class LIBARDOUR_API PortManager boost::shared_ptr register_port (DataType type, const std::string& portname, bool input, bool async = false, PortFlags extra_flags = PortFlags (0)); void port_registration_failure (const std::string& portname); - /** List of ports to be used between ::cycle_start() and ::cycle_end() - */ + /** List of ports to be used between \ref cycle_start() and \ref cycle_end() */ boost::shared_ptr _cycle_ports; void silence (pframes_t nframes, Session *s = 0); diff --git a/libs/ardour/ardour/processor.h b/libs/ardour/ardour/processor.h index a834a8c71a..e0b797b1b8 100644 --- a/libs/ardour/ardour/processor.h +++ b/libs/ardour/ardour/processor.h @@ -88,10 +88,17 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public virtual int set_block_size (pframes_t /*nframes*/) { return 0; } virtual bool requires_fixed_sized_buffers() const { return false; } - /** @param result_required true if, on return from this method, @a bufs is required to contain valid data; - * if false, the method need not bother writing to @a bufs if it doesn't want to. + /** The main process function for processors + * + * @param bufs bufferset of data to process in-place + * @param start_sample absolute timeline position in audio-samples to commence processing (latency compensated) + * @param end_sample absolute timeline position in audio-samples, usually start_sample +/- \param nframes + * @param speed transport speed. usually -1, 0, +1 + * @param nframes number of audio samples to process + * @param result_required true if, on return from this method, \param bufs is required to contain valid data; + * if false, the method need not bother writing to @a bufs if it doesn't want to. */ - virtual void run (BufferSet& /*bufs*/, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, double speed, pframes_t /*nframes*/, bool /*result_required*/) {} + virtual void run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool result_required) {} virtual void silence (samplecnt_t nframes, samplepos_t start_sample) { automation_run (start_sample, nframes); } virtual void activate () { _pending_active = true; ActiveChanged(); } diff --git a/libs/ardour/ardour/tempo.h b/libs/ardour/ardour/tempo.h index 47ee53038e..9e5124f1af 100644 --- a/libs/ardour/ardour/tempo.h +++ b/libs/ardour/ardour/tempo.h @@ -389,23 +389,24 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible TempoSection* next_tempo_section (TempoSection*) const; /** add a tempo section locked to pls. ignored values will be set in recompute_tempi() - * @param pulse pulse position of new section. ignored if pls == AudioTime - * @param sample frame position of new section. ignored if pls == MusicTime - * @param type type of new tempo section (Ramp, Constant) + * @param pulse pulse position of new section. ignored if \param pls == AudioTime + * @param sample frame position of new section. ignored if \param pls == MusicTime + * @param pls the position lock style */ TempoSection* add_tempo (const Tempo&, const double& pulse, const samplepos_t sample, PositionLockStyle pls); - /** add a meter section locked to pls.. ignored values will be set in recompute_meters() + /** add a meter section locked to \param pls . ignored values will be set in recompute_meters() * @param meter the Meter to be added * @param where bbt position of new section - * @param sample frame position of new section. ignored if pls == MusicTime - * note that @sample may also be ignored if it would create an un-solvable map + * @param sample frame position of new section. ignored if \param pls == MusicTime + * + * note that \param sample may also be ignored if it would create an un-solvable map * (previous audio-locked tempi may place the requested beat at an earlier time than sample) * in which case the new meter will be placed at the specified BBT. - * @param pls the position lock style + * @param pls the position lock style * * adding an audio-locked meter will add a meter-locked tempo section at the meter position. - * the meter-locked tempo tempo will be the Tempo at @beat + * the meter-locked tempo tempo will be the Tempo at the beat */ MeterSection* add_meter (const Meter& meter, const Timecode::BBT_Time& where, samplepos_t sample, PositionLockStyle pls); -- cgit v1.2.3