Mirrors/yuzu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

audio_core: Amend documentation tags

Browse source 
Resolves a wackload of -Wdocumentation warnings due to mismatching tags
and whatnot.
This commit is contained in:
Lioncash 2022-09-13 13:50:39 -04:00
parent 1be456db83
commit 2c91fbf7f1
28 changed files with 105 additions and 112 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/audio_core/sink/cubeb_sink.h
View file

@ -34,8 +34,7 @@ public:
* May differ from the device's channel count.
* @param name - Name of this stream.
* @param type - Type of this stream, render/in/out.
* @param event - Audio render only, a signal used to prevent the renderer running too
* fast.
*
* @return A pointer to the created SinkStream
*/
SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels,
@ -101,7 +100,7 @@ private:
};
/**
* Get a list of conencted devices from Cubeb.
* Get a list of connected devices from Cubeb.
*
* @param capture - Return input (capture) devices if true, otherwise output devices.
*/

5
src/audio_core/sink/sdl2_sink.h
View file

@ -32,8 +32,7 @@ public:
* May differ from the device's channel count.
* @param name - Name of this stream.
* @param type - Type of this stream, render/in/out.
* @param event - Audio render only, a signal used to prevent the renderer running too
* fast.
*
* @return A pointer to the created SinkStream
*/
SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels,
@ -92,7 +91,7 @@ private:
};
/**
* Get a list of conencted devices from Cubeb.
* Get a list of connected devices from SDL.
*
* @param capture - Return input (capture) devices if true, otherwise output devices.
*/

3
src/audio_core/sink/sink.h
View file

@ -58,8 +58,7 @@ public:
* May differ from the device's channel count.
* @param name - Name of this stream.
* @param type - Type of this stream, render/in/out.
* @param event - Audio render only, a signal used to prevent the renderer running too
* fast.
*
* @return A pointer to the created SinkStream
*/
virtual SinkStream* AcquireSinkStream(Core::System& system, u32 system_channels,

2
src/audio_core/sink/sink_stream.h
View file

@ -214,7 +214,7 @@ protected:
Core::System& system;
/// Type of this stream
StreamType type;
/// Set by the audio render/in/out systen which uses this stream
/// Set by the audio render/in/out system which uses this stream
u32 system_channels{2};
/// Channels supported by hardware
u32 device_channels{2};