diff options
| author | 2022-09-13 13:50:39 -0400 | |
|---|---|---|
| committer | 2022-09-15 09:47:23 -0400 | |
| commit | 2c91fbf7f1384b5cb01e20e4f59e27a1f9bd9a61 (patch) | |
| tree | 3191d4574de640a9f152df2f32cbc47a0458a9b8 /src/audio_core/sink | |
| parent | Merge pull request #8880 from german77/slow-moving (diff) | |
| download | yuzu-2c91fbf7f1384b5cb01e20e4f59e27a1f9bd9a61.tar.gz yuzu-2c91fbf7f1384b5cb01e20e4f59e27a1f9bd9a61.tar.xz yuzu-2c91fbf7f1384b5cb01e20e4f59e27a1f9bd9a61.zip | |
audio_core: Amend documentation tags
Resolves a wackload of -Wdocumentation warnings due to mismatching tags
and whatnot.
Diffstat (limited to 'src/audio_core/sink')
| -rw-r--r-- | src/audio_core/sink/cubeb_sink.h | 5 | ||||
| -rw-r--r-- | src/audio_core/sink/sdl2_sink.h | 5 | ||||
| -rw-r--r-- | src/audio_core/sink/sink.h | 3 | ||||
| -rw-r--r-- | src/audio_core/sink/sink_stream.h | 2 |
4 files changed, 6 insertions, 9 deletions
diff --git a/src/audio_core/sink/cubeb_sink.h b/src/audio_core/sink/cubeb_sink.h index 91a6480fa..a450a3343 100644 --- a/src/audio_core/sink/cubeb_sink.h +++ b/src/audio_core/sink/cubeb_sink.h | |||
| @@ -34,8 +34,7 @@ public: | |||
| 34 | * May differ from the device's channel count. | 34 | * May differ from the device's channel count. |
| 35 | * @param name - Name of this stream. | 35 | * @param name - Name of this stream. |
| 36 | * @param type - Type of this stream, render/in/out. | 36 | * @param type - Type of this stream, render/in/out. |
| 37 | * @param event - Audio render only, a signal used to prevent the renderer running too | 37 | * |
| 38 | * fast. | ||
| 39 | * @return A pointer to the created SinkStream | 38 | * @return A pointer to the created SinkStream |
| 40 | */ | 39 | */ |
| 41 | SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels, | 40 | SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels, |
| @@ -101,7 +100,7 @@ private: | |||
| 101 | }; | 100 | }; |
| 102 | 101 | ||
| 103 | /** | 102 | /** |
| 104 | * Get a list of conencted devices from Cubeb. | 103 | * Get a list of connected devices from Cubeb. |
| 105 | * | 104 | * |
| 106 | * @param capture - Return input (capture) devices if true, otherwise output devices. | 105 | * @param capture - Return input (capture) devices if true, otherwise output devices. |
| 107 | */ | 106 | */ |
diff --git a/src/audio_core/sink/sdl2_sink.h b/src/audio_core/sink/sdl2_sink.h index 57de9b6c2..b00f55849 100644 --- a/src/audio_core/sink/sdl2_sink.h +++ b/src/audio_core/sink/sdl2_sink.h | |||
| @@ -32,8 +32,7 @@ public: | |||
| 32 | * May differ from the device's channel count. | 32 | * May differ from the device's channel count. |
| 33 | * @param name - Name of this stream. | 33 | * @param name - Name of this stream. |
| 34 | * @param type - Type of this stream, render/in/out. | 34 | * @param type - Type of this stream, render/in/out. |
| 35 | * @param event - Audio render only, a signal used to prevent the renderer running too | 35 | * |
| 36 | * fast. | ||
| 37 | * @return A pointer to the created SinkStream | 36 | * @return A pointer to the created SinkStream |
| 38 | */ | 37 | */ |
| 39 | SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels, | 38 | SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels, |
| @@ -92,7 +91,7 @@ private: | |||
| 92 | }; | 91 | }; |
| 93 | 92 | ||
| 94 | /** | 93 | /** |
| 95 | * Get a list of conencted devices from Cubeb. | 94 | * Get a list of connected devices from SDL. |
| 96 | * | 95 | * |
| 97 | * @param capture - Return input (capture) devices if true, otherwise output devices. | 96 | * @param capture - Return input (capture) devices if true, otherwise output devices. |
| 98 | */ | 97 | */ |
diff --git a/src/audio_core/sink/sink.h b/src/audio_core/sink/sink.h index 43d99b62e..b3f65792d 100644 --- a/src/audio_core/sink/sink.h +++ b/src/audio_core/sink/sink.h | |||
| @@ -58,8 +58,7 @@ public: | |||
| 58 | * May differ from the device's channel count. | 58 | * May differ from the device's channel count. |
| 59 | * @param name - Name of this stream. | 59 | * @param name - Name of this stream. |
| 60 | * @param type - Type of this stream, render/in/out. | 60 | * @param type - Type of this stream, render/in/out. |
| 61 | * @param event - Audio render only, a signal used to prevent the renderer running too | 61 | * |
| 62 | * fast. | ||
| 63 | * @return A pointer to the created SinkStream | 62 | * @return A pointer to the created SinkStream |
| 64 | */ | 63 | */ |
| 65 | virtual SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels, | 64 | virtual SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels, |
diff --git a/src/audio_core/sink/sink_stream.h b/src/audio_core/sink/sink_stream.h index db7cff45e..5e9a86a10 100644 --- a/src/audio_core/sink/sink_stream.h +++ b/src/audio_core/sink/sink_stream.h | |||
| @@ -214,7 +214,7 @@ protected: | |||
| 214 | Core::System& system; | 214 | Core::System& system; |
| 215 | /// Type of this stream | 215 | /// Type of this stream |
| 216 | StreamType type; | 216 | StreamType type; |
| 217 | /// Set by the audio render/in/out systen which uses this stream | 217 | /// Set by the audio render/in/out system which uses this stream |
| 218 | u32 system_channels{2}; | 218 | u32 system_channels{2}; |
| 219 | /// Channels supported by hardware | 219 | /// Channels supported by hardware |
| 220 | u32 device_channels{2}; | 220 | u32 device_channels{2}; |