[pulseaudio-discuss] [PATCH 2/4] channelmap: Document pa_channel_position_from_string() error handling.

[Tanu Kaskinen]

---
 src/pulse/channelmap.h |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/src/pulse/channelmap.h b/src/pulse/channelmap.h
index 1c3eef4..35276ed 100644
--- a/src/pulse/channelmap.h
+++ b/src/pulse/channelmap.h
@@ -295,7 +295,8 @@ pa_channel_map* pa_channel_map_init_extend(pa_channel_map *m, unsigned channels,
 /** Return a text label for the specified channel position */
 const char* pa_channel_position_to_string(pa_channel_position_t pos) PA_GCC_PURE;
 
-/** The inverse of pa_channel_position_to_string(). \since 0.9.16 */
+/** The inverse of pa_channel_position_to_string(). Returns
+ * PA_CHANNEL_POSITION_INVALID on failure. \since 0.9.16 */
 pa_channel_position_t pa_channel_position_from_string(const char *s) PA_GCC_PURE;
 
 /** Return a human readable text label for the specified channel position. \since 0.9.7 */
-- 
1.7.7.3