mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-18 06:59:57 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

api documentation improvements

Browse source 
includes typo fixes, neatening, addition of more return info, and such.
This commit is contained in:
jnqnfe 2017-09-04 20:19:48 +01:00 • committed by Tanu Kaskinen
parent 7973dfd768
commit b683350856
15 changed files with 205 additions and 143 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/pulse/channelmap.h
View file

@ -46,10 +46,12 @@
*
* \li pa_channel_map_init_mono() - Create a channel map with only mono audio.
* \li pa_channel_map_init_stereo() - Create a standard stereo mapping.
* \li pa_channel_map_init_auto() - Create a standard channel map for a specific number of channels
* \li pa_channel_map_init_extend() - Similar to
* pa_channel_map_init_auto() but synthesize a channel map if no
* predefined one is known for the specified number of channels.
* \li pa_channel_map_init_auto() - Create a standard channel map for a specific
* number of channels.
* \li pa_channel_map_init_extend() - Similar to pa_channel_map_init_auto() but
* synthesize a channel map if no predefined
* one is known for the specified number of
* channels.
*
* \section conv_sec Convenience Functions
*
@ -261,7 +263,7 @@ typedef enum pa_channel_map_def {
* mixing of streams */
typedef struct pa_channel_map {
uint8_t channels;
/**< Number of channels */
/**< Number of channels mapped */
pa_channel_position_t map[PA_CHANNELS_MAX];
/**< Channel labels */
@ -306,7 +308,7 @@ const char* pa_channel_position_to_pretty_string(pa_channel_position_t pos);
* it might become part of an ABI. */
#define PA_CHANNEL_MAP_SNPRINT_MAX 336
/** Make a human readable string from the specified channel map */
/** Make a human readable string from the specified channel map. Returns \a s. */
char* pa_channel_map_snprint(char *s, size_t l, const pa_channel_map *map);
/** Parse a channel position list or well-known mapping name into a