avformat/qtpalette: Move ff_get_qtpalette() doxy to header

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>

1 files changed, 9 insertions, 0 deletions

diff --git a/libavformat/qtpalette.h b/libavformat/qtpalette.h
index 54da2a1083..da83421d84 100644
--- a/libavformat/qtpalette.h
+++ b/libavformat/qtpalette.h
@@ -311,6 +311,15 @@ static const uint8_t ff_qt_default_palette_256[256 * 3] = {
   /* 255, 0xFF */  0x00, 0x00, 0x00
 };
 
+/**
+ * Retrieve the palette (or "color table" in QuickTime terms), either
+ * from the video sample description, or from the default Macintosh
+ * palette.
+ *
+ * The file offset of the AVIOContext pointed to by the 'pb' variable
+ * should be the start of the video sample description (the sample
+ * description size and the data format).
+ */
 int ff_get_qtpalette(int codec_id, AVIOContext *pb, uint32_t *palette);
 
 #endif /* AVFORMAT_QTPALETTE_H */