summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2023-05-11 13:45:02 +0200
committerCarl Hetherington <cth@carlh.net>2023-05-12 22:11:06 +0200
commit4f81cdeb7802d2087244590a801ecc1a64eff0aa (patch)
tree1d2a9d08e4ada497f9d051ecfdc53634d7e14705
parent8eedbed6e1f5b59e9714d7f857f486d8cf5f9434 (diff)
Fix comment.
-rw-r--r--src/lib/dcp_examiner.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/lib/dcp_examiner.h b/src/lib/dcp_examiner.h
index 75ea8b68c..6bbdef4e4 100644
--- a/src/lib/dcp_examiner.h
+++ b/src/lib/dcp_examiner.h
@@ -103,7 +103,9 @@ public:
}
/** @param type TEXT_OPEN_SUBTITLE or TEXT_CLOSED_CAPTION.
- * @return Number of assets of this type in this DCP.
+ * @return the number of "streams" of this type in the DCP.
+ * Reels do not affect the return value of this method: if a DCP
+ * has any subtitles, type=TEXT_OPEN_SUBTITLE will return 1.
*/
int text_count (TextType type) const {
return _text_count[type];