Some small documentation tweaks.
authorCarl Hetherington <cth@carlh.net>
Mon, 7 Mar 2022 22:10:45 +0000 (23:10 +0100)
committerCarl Hetherington <cth@carlh.net>
Mon, 14 Mar 2022 22:06:10 +0000 (23:06 +0100)
src/cpl.h
src/types.cc

index 66310247b5aa5358c04d3ff7bf02ea06da53b904..43c8a56ebb3f9f19e6e5b120fe01959316a74705 100644 (file)
--- 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
 {
index 077836e03b9127d906c297314592bacfce62e242..c990479238fbae09db13e533d52bc903fca893a8 100644 (file)
@@ -73,7 +73,7 @@ bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b)
 }
 
 
-/** Construct a Fraction from a string of the form <numerator> <denominator>
+/** Construct a Fraction from a string of the form "numerator denominator"
  *  e.g. "1 3".
  */
 Fraction::Fraction (string s)