From db975c7127c15a527ef6277a695eba2870613637 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 3 Oct 2008 17:15:43 +0200 Subject: extend documentation for pa_channel_map_init() --- src/pulse/channelmap.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/pulse/channelmap.h b/src/pulse/channelmap.h index d2dd6f8f..8ea3daec 100644 --- a/src/pulse/channelmap.h +++ b/src/pulse/channelmap.h @@ -175,7 +175,9 @@ typedef struct pa_channel_map { /**< Channel labels */ } pa_channel_map; -/** Initialize the specified channel map and return a pointer to it */ +/** Initialize the specified channel map and return a pointer to + * it. The channel map will have a defined state but + * pa_channel_map_valid() will fail for it. */ pa_channel_map* pa_channel_map_init(pa_channel_map *m); /** Initialize the specified channel map for monoaural audio and return a pointer to it */ -- cgit