Add some comments to video.h

diff --git a/src/video.h b/src/video.h
index 77f2c93d84c8a9454d6e71f6cd588481dc1572ae..9c907bc482df623e822973639097e1658562210f 100644 (file)
--- a/src/video.h
+++ b/src/video.h
@@ -13,6 +13,11 @@ constexpr unsigned int kReadBufPaddingSize = AV_INPUT_BUFFER_PADDING_SIZE;
 constexpr unsigned int kReadBufSizeWithPadding =
     kReadBufSize + kReadBufPaddingSize;
 
+/*!
+ * \brief Helper class that uses Image and OpenCLHandle to dither video frames.
+ *
+ * Note that libraries provided by ffmpeg are used to decode the video.
+ */
 class Video {
  public:
   explicit Video(const char *video_filename);
@@ -20,8 +25,15 @@ class Video {
 
   ~Video();
 
+  /// Same as DitherVideo(const std::string&, Image*, bool)
   bool DitherVideo(const char *output_filename, Image *blue_noise,
                    bool grayscale = false);
+
+  /*!
+   * \brief Dithers the frames in the input video.
+   *
+   * \return True on success.
+   */
   bool DitherVideo(const std::string &output_filename, Image *blue_noise,
                    bool grayscale = false);