extend documentation for pa_channel_map_init()

diff --git a/src/pulse/channelmap.h b/src/pulse/channelmap.h
index d2dd6f8f917ed4f3f3fd583795a2de1e9b9bb633..8ea3daec49b92edbb6ea7118f2981dfb39739cda 100644 (file)
--- 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 */