document vlc_fourcc_to_char() function.

diff --git a/include/vlc_common.h b/include/vlc_common.h
index 8b1c32b7f79937c1651186801113ded9333aa8a4..52d01ca657a82e4eecf40c39ddf7b1a6dd893f85 100644 (file)
--- a/include/vlc_common.h
+++ b/include/vlc_common.h
@@ -106,6 +106,13 @@ typedef uint32_t vlc_fourcc_t;
 
 #endif
 
+/**
+ * Translate a vlc_fourcc into its string representation. This function
+ * assumes there is enough room in psz_fourcc to store 4 characters in.
+ *
+ * \param fcc a vlc_fourcc_t
+ * \param psz_fourcc string to store string representation of vlc_fourcc in
+ */
 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
 {
     memcpy( psz_fourcc, &fcc, 4 );