From 0cb52ee74a8255eb0320c882bc9e70700317d16a Mon Sep 17 00:00:00 2001 From: Mat M Date: Sun, 26 Feb 2017 20:58:51 -0500 Subject: Doxygen: Amend minor issues (#2593) Corrects a few issues with regards to Doxygen documentation, for example: - Incorrect parameter referencing. - Missing @param tags. - Typos in @param tags. and a few minor other issues. --- src/audio_core/hle/filter.h | 2 +- src/audio_core/interpolate.h | 2 ++ src/audio_core/sink.h | 2 +- src/audio_core/time_stretch.h | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) (limited to 'src/audio_core') diff --git a/src/audio_core/hle/filter.h b/src/audio_core/hle/filter.h index 4281a5898..5350e2857 100644 --- a/src/audio_core/hle/filter.h +++ b/src/audio_core/hle/filter.h @@ -27,7 +27,7 @@ public: * See also: SourceConfiguration::Configuration::simple_filter_enabled, * SourceConfiguration::Configuration::biquad_filter_enabled. * @param simple If true, enables the simple filter. If false, disables it. - * @param simple If true, enables the biquad filter. If false, disables it. + * @param biquad If true, enables the biquad filter. If false, disables it. */ void Enable(bool simple, bool biquad); diff --git a/src/audio_core/interpolate.h b/src/audio_core/interpolate.h index dd06fdda9..19a7b66cb 100644 --- a/src/audio_core/interpolate.h +++ b/src/audio_core/interpolate.h @@ -21,6 +21,7 @@ struct State { /** * No interpolation. This is equivalent to a zero-order hold. There is a two-sample predelay. + * @param state Interpolation state. * @param input Input buffer. * @param rate_multiplier Stretch factor. Must be a positive non-zero value. * rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 @@ -31,6 +32,7 @@ StereoBuffer16 None(State& state, const StereoBuffer16& input, float rate_multip /** * Linear interpolation. This is equivalent to a first-order hold. There is a two-sample predelay. + * @param state Interpolation state. * @param input Input buffer. * @param rate_multiplier Stretch factor. Must be a positive non-zero value. * rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 diff --git a/src/audio_core/sink.h b/src/audio_core/sink.h index 558c8c0fe..c69cb2c74 100644 --- a/src/audio_core/sink.h +++ b/src/audio_core/sink.h @@ -34,7 +34,7 @@ public: /** * Sets the desired output device. - * @paran device_id Id of the desired device. + * @param device_id ID of the desired device. */ virtual void SetDevice(int device_id) = 0; diff --git a/src/audio_core/time_stretch.h b/src/audio_core/time_stretch.h index e3e4dc353..c98b16705 100644 --- a/src/audio_core/time_stretch.h +++ b/src/audio_core/time_stretch.h @@ -25,7 +25,7 @@ public: /** * Add samples to be processed. * @param sample_buffer Buffer of samples in interleaved stereo PCM16 format. - * @param num_sample Number of samples. + * @param num_samples Number of samples. */ void AddSamples(const s16* sample_buffer, size_t num_samples); -- cgit v1.2.3