summaryrefslogtreecommitdiff
path: root/src/cpl.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2012-08-22 16:18:04 +0100
committerCarl Hetherington <cth@carlh.net>2012-08-22 16:18:04 +0100
commit28ad2d566af1f59274fd1e16f6ba5da7479fc197 (patch)
treedc91c6dd67aa0eb2e2272ebee37f793c02880a2b /src/cpl.h
parente75aef94aa603f5fa464a2b01ad4a19ce9f72c41 (diff)
Comment tweaks.
Diffstat (limited to 'src/cpl.h')
-rw-r--r--src/cpl.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/cpl.h b/src/cpl.h
index e06e2351..8f5682da 100644
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -125,7 +125,12 @@ public:
std::string label_text;
};
-/** Class to parse a CPL */
+/** @class CPL
+ * @brief Class to parse a CPL
+ *
+ * This class is used to parse XML CPL files. It is rarely necessary
+ * for the caller to use it outside libdcp.
+ */
class CPL : public XMLFile
{
public: