Comments.

diff --git a/src/cpl.h b/src/cpl.h
index 75b9d701c7ee5ae6cf14bf238cf3c2a520cca274..164ed734eb7f421e03a52d329466024821bdda0b 100644 (file)
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/cpl.h
+ *  @brief CPL class.
+ */
+
 #ifndef LIBDCP_CPL_H
 #define LIBDCP_CPL_H
 

diff --git a/src/decrypted_kdm.h b/src/decrypted_kdm.h
index 0f305a165a937f7ea300fdeb78cdf3cffc21d624..bb50d6ada9565380746eb097658be1c9d9f87af6 100644 (file)
--- a/src/decrypted_kdm.h
+++ b/src/decrypted_kdm.h
@@ -38,7 +38,7 @@ class CPL;
  *  @brief A decrypted KDM.
  *
  *  This is a KDM that has either been decrypted by a target private key, or one which
- *  has been created by some other means, ready for encryption later.
+ *  has been created (by some other means) ready for encryption later.
  *
  *  A DecryptedKDM object can be created either from an EncryptedKDM and private key file,
  *  or from the details of the MXFs that the KDM should protect.
@@ -54,7 +54,7 @@ public:
        /** Construct a DecryptedKDM.
         *  @param cpl CPL that the keys are for.
         *  @param not_valid_before Start time for the KDM.
-        *  @param not_valid_after ENd time for the KDM.
+        *  @param not_valid_after End time for the KDM.
         */
        DecryptedKDM (
                boost::shared_ptr<const CPL> cpl,

diff --git a/src/decrypted_kdm_key.h b/src/decrypted_kdm_key.h
index 58448b7af590fa002281684b503fa622d164e843..2a06199c573a99ead385795943da1e9017ac73a4 100644 (file)
--- a/src/decrypted_kdm_key.h
+++ b/src/decrypted_kdm_key.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/decrypted_kdm_key.h
+ *  @brief DecryptedKDMKey class
+ */
+
 #ifndef LIBDCP_DECRYPTED_KDM_KEY_H
 #define LIBDCP_DECRYPTED_KDM_KEY_H
 
@@ -24,6 +28,9 @@
 
 namespace dcp {
 
+/** @class DecryptedKDMKey
+ *  @brief An un- or de-crypted key from a KDM.
+ */
 class DecryptedKDMKey
 {
 public:

diff --git a/src/font.h b/src/font.h
index 1b29e570116184cf8f99ac37caa4897f8e107973..0250e997242c436b3865af7aab618239fac33434 100644 (file)
--- a/src/font.h
+++ b/src/font.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/font.h
+ *  @brief Font class
+ */
+
 #include "types.h"
 #include "subtitle.h"
 #include <boost/shared_ptr.hpp>
@@ -28,7 +32,10 @@ namespace cxml {
 }
 
 namespace dcp {
-       
+
+/** @class Font
+ *  @brief Helper class for parsing subtitle XML.
+ */
 class Font 
 {
 public:

diff --git a/src/subtitle_string.h b/src/subtitle_string.h
index 076a6ec7437210b9dfcbd11a76c67512cdd2736d..03d3d4f82bd59c34322ec48e7cd03301ab476371 100644 (file)
--- a/src/subtitle_string.h
+++ b/src/subtitle_string.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/subtitle_string.h
+ *  @brief SubtitleString class.
+ */
+
 #ifndef LIBDCP_SUBTITLE_STRING_H
 #define LIBDCP_SUBTITLE_STRING_H
 
@@ -26,6 +30,9 @@
 
 namespace dcp {
 
+/** @class SubtitleString
+ *  @brief A single line of subtitle text with all the associated attributes.
+ */
 class SubtitleString
 {
 public:
@@ -100,8 +107,11 @@ public:
        int size_in_pixels (int screen_height) const;
 
 private:
+       /** font name */
        std::string _font;
+       /** true if the text is italic */
        bool _italic;
+       /** text colour */
        Color _color;
        /** Size in points as if the screen height is 11 inches, so a 72pt font
         *  would be 1/11th of the screen height.