diff options
| author | 2017-02-26 20:58:51 -0500 | |
|---|---|---|
| committer | 2017-02-26 17:58:51 -0800 | |
| commit | 0cb52ee74a8255eb0320c882bc9e70700317d16a (patch) | |
| tree | 800920c60df4d183d20d94465e0886e5655216a0 /src/audio_core | |
| parent | Merge pull request #2587 from yuriks/status-bar (diff) | |
| download | yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.tar.gz yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.tar.xz yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.zip | |
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.
Diffstat (limited to 'src/audio_core')
| -rw-r--r-- | src/audio_core/hle/filter.h | 2 | ||||
| -rw-r--r-- | src/audio_core/interpolate.h | 2 | ||||
| -rw-r--r-- | src/audio_core/sink.h | 2 | ||||
| -rw-r--r-- | src/audio_core/time_stretch.h | 2 |
4 files changed, 5 insertions, 3 deletions
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: | |||
| 27 | * See also: SourceConfiguration::Configuration::simple_filter_enabled, | 27 | * See also: SourceConfiguration::Configuration::simple_filter_enabled, |
| 28 | * SourceConfiguration::Configuration::biquad_filter_enabled. | 28 | * SourceConfiguration::Configuration::biquad_filter_enabled. |
| 29 | * @param simple If true, enables the simple filter. If false, disables it. | 29 | * @param simple If true, enables the simple filter. If false, disables it. |
| 30 | * @param simple If true, enables the biquad filter. If false, disables it. | 30 | * @param biquad If true, enables the biquad filter. If false, disables it. |
| 31 | */ | 31 | */ |
| 32 | void Enable(bool simple, bool biquad); | 32 | void Enable(bool simple, bool biquad); |
| 33 | 33 | ||
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 { | |||
| 21 | 21 | ||
| 22 | /** | 22 | /** |
| 23 | * No interpolation. This is equivalent to a zero-order hold. There is a two-sample predelay. | 23 | * No interpolation. This is equivalent to a zero-order hold. There is a two-sample predelay. |
| 24 | * @param state Interpolation state. | ||
| 24 | * @param input Input buffer. | 25 | * @param input Input buffer. |
| 25 | * @param rate_multiplier Stretch factor. Must be a positive non-zero value. | 26 | * @param rate_multiplier Stretch factor. Must be a positive non-zero value. |
| 26 | * rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 | 27 | * 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 | |||
| 31 | 32 | ||
| 32 | /** | 33 | /** |
| 33 | * Linear interpolation. This is equivalent to a first-order hold. There is a two-sample predelay. | 34 | * Linear interpolation. This is equivalent to a first-order hold. There is a two-sample predelay. |
| 35 | * @param state Interpolation state. | ||
| 34 | * @param input Input buffer. | 36 | * @param input Input buffer. |
| 35 | * @param rate_multiplier Stretch factor. Must be a positive non-zero value. | 37 | * @param rate_multiplier Stretch factor. Must be a positive non-zero value. |
| 36 | * rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 | 38 | * 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: | |||
| 34 | 34 | ||
| 35 | /** | 35 | /** |
| 36 | * Sets the desired output device. | 36 | * Sets the desired output device. |
| 37 | * @paran device_id Id of the desired device. | 37 | * @param device_id ID of the desired device. |
| 38 | */ | 38 | */ |
| 39 | virtual void SetDevice(int device_id) = 0; | 39 | virtual void SetDevice(int device_id) = 0; |
| 40 | 40 | ||
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: | |||
| 25 | /** | 25 | /** |
| 26 | * Add samples to be processed. | 26 | * Add samples to be processed. |
| 27 | * @param sample_buffer Buffer of samples in interleaved stereo PCM16 format. | 27 | * @param sample_buffer Buffer of samples in interleaved stereo PCM16 format. |
| 28 | * @param num_sample Number of samples. | 28 | * @param num_samples Number of samples. |
| 29 | */ | 29 | */ |
| 30 | void AddSamples(const s16* sample_buffer, size_t num_samples); | 30 | void AddSamples(const s16* sample_buffer, size_t num_samples); |
| 31 | 31 | ||