Tidying.

[libdcp.git] / src / subtitle_string.h

diff --git a/src/subtitle_string.h b/src/subtitle_string.h
index 8e798d8ec6fdcb19ebe638efcf7dbba41d2e2ea8..bf9c87d9036cf32f1919872d773c2dc22afc07a8 100644 (file)
--- a/src/subtitle_string.h
+++ b/src/subtitle_string.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -31,27 +31,52 @@
     files in the program, then also delete it here.
 */
 
+
 /** @file  src/subtitle_string.h
- *  @brief SubtitleString class.
+ *  @brief SubtitleString class
  */
 
+
 #ifndef LIBDCP_SUBTITLE_STRING_H
 #define LIBDCP_SUBTITLE_STRING_H
 
+
 #include "types.h"
 #include "subtitle.h"
 #include "dcp_time.h"
 #include <boost/optional.hpp>
 #include <string>
 
+
 namespace dcp {
 
+
 /** @class SubtitleString
  *  @brief A single line of subtitle text with all the associated attributes.
  */
 class SubtitleString : public Subtitle
 {
 public:
+       /** @param font Font ID, or empty to use the default
+        *  @param italic true for italic text
+        *  @param bold true for bold text
+        *  @param underline true for underlined text
+        *  @param colour Colour of the text
+        *  @param size Size in points as if the screen height is 11 inches, so a 72pt font would be 1/11th of the screen height
+        *  @param aspect_adjust greater than 1 to stretch text to be wider, less than 1 to shrink text to be narrower (must be between 0.25 and 4)
+        *  @param in start time
+        *  @param out finish time
+        *  @param h_position Horizontal position as a fraction of the screen width (between 0 and 1) from h_align
+        *  @param h_align Horizontal alignment point
+        *  @param v_position Vertical position as a fraction of the screen height (between 0 and 1) from v_align
+        *  @param v_align Vertical alignment point
+        *  @param direction Direction of text
+        *  @param text The text to display
+        *  @param effect Effect to use
+        *  @param effect_colour Colour of the effect
+        *  @param fade_up_time Time to fade the text in
+        *  @param fade_down_time Time to fade the text out
+        */
        SubtitleString (
                boost::optional<std::string> font,
                bool italic,
@@ -183,6 +208,8 @@ bool operator== (SubtitleString const & a, SubtitleString const & b);
 bool operator!= (SubtitleString const & a, SubtitleString const & b);
 std::ostream& operator<< (std::ostream& s, SubtitleString const & sub);
 
+
 }
 
+
 #endif