From ac20dc545baea99fcec8f966cff858bc1c9bdc8e Mon Sep 17 00:00:00 2001 From: Jean-Paul Saman Date: Tue, 12 Aug 2008 12:32:52 +0800 Subject: [PATCH] document vlc_fourcc_to_char() function. --- include/vlc_common.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/vlc_common.h b/include/vlc_common.h index 8b1c32b7f7..52d01ca657 100644 --- 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 ); -- 2.39.2