[vlc-devel] commit: document vlc_fourcc_to_char() function. (Jean-Paul Saman )

[git version control]

vlc | branch: master | Jean-Paul Saman <jpsaman at videolan.org> | Tue Aug 12 12:32:52 2008 +0800| [ac20dc545baea99fcec8f966cff858bc1c9bdc8e] | committer: Jean-Paul Saman 

document vlc_fourcc_to_char() function.

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=ac20dc545baea99fcec8f966cff858bc1c9bdc8e
---

 include/vlc_common.h |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/include/vlc_common.h b/include/vlc_common.h
index 8b1c32b..52d01ca 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 );