summaryrefslogtreecommitdiff
path: root/src/audio_core/interpolate.h
diff options
context:
space:
mode:
authorGravatar Mat M2017-02-26 20:58:51 -0500
committerGravatar Yuri Kunde Schlesner2017-02-26 17:58:51 -0800
commit0cb52ee74a8255eb0320c882bc9e70700317d16a (patch)
tree800920c60df4d183d20d94465e0886e5655216a0 /src/audio_core/interpolate.h
parentMerge pull request #2587 from yuriks/status-bar (diff)
downloadyuzu-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/interpolate.h')
-rw-r--r--src/audio_core/interpolate.h2
1 files changed, 2 insertions, 0 deletions
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