document vlc_fourcc_to_char() function.
authorJean-Paul Saman <jpsaman@videolan.org>
Tue, 12 Aug 2008 04:32:52 +0000 (12:32 +0800)
committerJean-Paul Saman <jean-paul.saman@m2x.nl>
Wed, 27 Aug 2008 12:44:31 +0000 (14:44 +0200)
include/vlc_common.h

index 8b1c32b..52d01ca 100644 (file)
@@ -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 );