summaryrefslogtreecommitdiff
path: root/src/cpl.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2022-03-07 23:10:45 +0100
committerCarl Hetherington <cth@carlh.net>2022-03-07 23:10:45 +0100
commite08f446c1f73b0190facbd9893a10897fbbf1033 (patch)
treeb35445530491da9b65f26df1d4bd413b107708f1 /src/cpl.h
parent74f639adc8ddb21d3de095cdb5d5a529bdbf7a2c (diff)
Some small documentation tweaks.
Diffstat (limited to 'src/cpl.h')
-rw-r--r--src/cpl.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/cpl.h b/src/cpl.h
index 66310247..43c8a56e 100644
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -69,6 +69,12 @@ class DecryptedKDM;
/** @class CPL
* @brief A Composition Playlist
+ *
+ * A CPL contains some metadata and a list of Reel objects, each of which may contain picture, sound and other assets
+ * such as subtitles and closed captions.
+ *
+ * After creating a CPL you can add Reel objects with add(), and write an XML file describing the CPL with
+ * write_xml().
*/
class CPL : public Asset
{