X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Flib%2Fcinema.h;h=74357f65d687e0261ded537e94b3b4f95afcfdb2;hb=3c4eb194c031950165ab63785368784a38bd752d;hp=d8e28ecfdecfecc569d68396cf5742a063a19d4a;hpb=58588c485eac7c488a574fe923576f109ec0134e;p=dcpomatic.git

diff --git a/src/lib/cinema.h b/src/lib/cinema.h
index d8e28ecfd..74357f65d 100644
--- a/src/lib/cinema.h
+++ b/src/lib/cinema.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,15 +17,22 @@
 
 */
 
+/** @file  src/lib/cinema.h
+ *  @brief Screen and Cinema classes.
+ */
+
 #include <boost/enable_shared_from_this.hpp>
 #include <dcp/certificates.h>
+#include <libcxml/cxml.h>
 
 class Cinema;
 
-namespace cxml {
-	class Node;
-}
-
+/** @class Screen
+ *  @brief A representation of a Screen for KDM generation.
+ *
+ *  This is the name of the screen and the certificate of its
+ *  server.
+ */
 class Screen
 {
 public:
@@ -34,7 +41,7 @@ public:
 		, certificate (cert)
 	{}
 
-	Screen (boost::shared_ptr<const cxml::Node>);
+	Screen (cxml::ConstNodePtr);
 
 	void as_xml (xmlpp::Element *) const;
 	
@@ -43,6 +50,12 @@ public:
 	boost::shared_ptr<dcp::Certificate> certificate;
 };
 
+/** @class Cinema
+ *  @brief A description of a Cinema for KDM generation.
+ *
+ *  This is a cinema name, contact email address and a list of
+ *  Screen objects.
+ */
 class Cinema : public boost::enable_shared_from_this<Cinema>
 {
 public:
@@ -51,9 +64,9 @@ public:
 		, email (e)
 	{}
 
-	Cinema (boost::shared_ptr<const cxml::Node>);
+	Cinema (cxml::ConstNodePtr);
 
-	void read_screens (boost::shared_ptr<const cxml::Node>);
+	void read_screens (cxml::ConstNodePtr);
 
 	void as_xml (xmlpp::Element *) const;