From 45e79bf2dbc106f00fcdb21234066dcfe5ebc2ef Mon Sep 17 00:00:00 2001
From: Carl Hetherington <cth@carlh.net>
Date: Mon, 7 Mar 2022 23:10:45 +0100
Subject: Some small documentation tweaks.

---
 src/cpl.h    | 6 ++++++
 src/types.cc | 2 +-
 2 files changed, 7 insertions(+), 1 deletion(-)

(limited to 'src')

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
 {
diff --git a/src/types.cc b/src/types.cc
index 077836e0..c9904792 100644
--- a/src/types.cc
+++ b/src/types.cc
@@ -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)
-- 
cgit v1.2.3