Cleanup: comment formatting for auto-generated docs.

[libdcp.git] / src / verify.h

diff --git a/src/verify.h b/src/verify.h
index 69a10292b2f16e052fc0bce5879a6f4cca6b50b9..37a1fc11400fba8235faa4896e93ffd9039a27b0 100644 (file)
--- a/src/verify.h
+++ b/src/verify.h
@@ -50,7 +50,7 @@
 #include <vector>
 
 
-/* Something in windows.h defines this */
+/* windows.h defines this but we want to use it */
 #undef ERROR
 
 
@@ -413,7 +413,7 @@ public:
                 *  file contains the ASSETMAP filename
                 */
                DUPLICATE_ASSET_ID_IN_ASSETMAP,
-               /** An Interop subtitle asset has no subtitles.
+               /** An Interop subtitle asset has no subtitles
                 *  note contains the asset ID
                 *  file contains the asset filename
                 */
@@ -444,6 +444,24 @@ public:
                 *  size contains the invalid size in bytes.
                 */
                INVALID_JPEG2000_TILE_PART_SIZE,
+               /** A subtitle XML root node has more than one namespace (xmlns) declaration.
+                *  note contains the asset ID
+                */
+               INCORRECT_SUBTITLE_NAMESPACE_COUNT,
+               /** A subtitle or closed caption file has a <Font> tag which refers to a font that is not
+                *  first introduced with a <LoadFont>.
+                *  id contains the ID of the <Font> tag.
+                */
+               MISSING_LOAD_FONT_FOR_FONT,
+               /** A SMPTE subtitle asset has at least one <Text> element but no <LoadFont>
+                *  id contains the ID of the subtitle asset.
+                */
+               MISSING_LOAD_FONT,
+               /** An ID in an asset map does not match the ID obtained from reading the actual file.
+                *  id contains the ID from the asset map.
+                *  other_id contains the ID from the file.
+                */
+               MISMATCHED_ASSET_MAP_ID,
        };
 
        VerificationNote (Type type, Code code)
@@ -498,6 +516,8 @@ private:
                FRAME,
                COMPONENT,
                SIZE,
+               ID,
+               OTHER_ID,
        };
 
        template <class T>
@@ -550,6 +570,24 @@ public:
                return data<int>(Data::SIZE);
        }
 
+       VerificationNote& set_id(std::string id) {
+               _data[Data::ID] = id;
+               return *this;
+       }
+
+       boost::optional<std::string> id() const {
+               return data<std::string>(Data::ID);
+       }
+
+       VerificationNote& set_other_id(std::string other_id) {
+               _data[Data::OTHER_ID] = other_id;
+               return *this;
+       }
+
+       boost::optional<std::string> other_id() const {
+               return data<std::string>(Data::OTHER_ID);
+       }
+
 private:
        Type _type;
        Code _code;