diff options
author | Mat M <mathew1800@gmail.com> | 2017-02-26 20:58:51 -0500 |
---|---|---|
committer | Yuri Kunde Schlesner <yuriks@yuriks.net> | 2017-02-26 17:58:51 -0800 |
commit | 0cb52ee74a8255eb0320c882bc9e70700317d16a (patch) | |
tree | 800920c60df4d183d20d94465e0886e5655216a0 /src/audio_core/interpolate.h | |
parent | b250ce21b9a62cb573540fdb14f30c28fa66e6ad (diff) |
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.h | 2 |
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 { /** * 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 |