GPL boilerplate and a few comments.

diff --git a/src/asset_map.cc b/src/asset_map.cc
index 3e0a0545a46fae0e9ad11bc55c913bbf8788a8d6..3af2d6f8df4cd4e1b5c3bf9f56ac3f766784560b 100644 (file)
--- a/src/asset_map.cc
+++ b/src/asset_map.cc
@@ -1,3 +1,26 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/asset_map.cc
+ *  @brief Classes used to parse a AssetMap.
+ */
+
 #include "asset_map.h"
 
 using namespace std;

diff --git a/src/asset_map.h b/src/asset_map.h
index 3f51ca12b8bc07bc2ad1eccce56a69fa1521b546..430cb5aa9e96e770470dd9734f19ac8d873e3f8c 100644 (file)
--- a/src/asset_map.h
+++ b/src/asset_map.h
@@ -1,3 +1,26 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/asset_map.h
+ *  @brief Classes used to parse a AssetMap.
+ */
+
 #include <stdint.h>
 #include <boost/shared_ptr.hpp>
 #include "xml.h"

diff --git a/src/cpl.cc b/src/cpl.cc
index 137d359f9cf936fb155ffaea203d19897778e10d..f7bf43f5f49a867f9c3fa97814d6797bea7b73d5 100644 (file)
--- a/src/cpl.cc
+++ b/src/cpl.cc
@@ -1,3 +1,26 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/cpl.cc
+ *  @brief Classes used to parse a CPL.
+ */
+
 #include <iostream>
 #include "cpl.h"
 

diff --git a/src/cpl.h b/src/cpl.h
index 5dd2c37bf342f7e75b5599e7162033db64c97fe0..ed42c3a9908605ebeaa46e8531bc75f07ebe17c9 100644 (file)
--- a/src/cpl.h
+++ b/src/cpl.h
@@ -1,9 +1,33 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/cpl.h
+ *  @brief Classes used to parse a CPL.
+ */
+
 #include <stdint.h>
 #include <boost/shared_ptr.hpp>
 #include "xml.h"
 
 namespace libdcp {
 
+/** CPL MainPicture node */    
 class MainPicture : public XMLNode
 {
 public:
@@ -20,6 +44,7 @@ public:
        Fraction screen_aspect_ratio;
 };
 
+/** CPL MainSound node */      
 class MainSound : public XMLNode
 {
 public:
@@ -34,6 +59,7 @@ public:
        int64_t duration;
 };
 
+/** CPL MainSubtitle node */   
 class MainSubtitle : public XMLNode
 {
 public:
@@ -48,6 +74,7 @@ public:
        int64_t duration;
 };
 
+/** CPL AssetList node */      
 class CPLAssetList : public XMLNode
 {
 public:
@@ -59,6 +86,7 @@ public:
        boost::shared_ptr<MainSubtitle> main_subtitle;
 };
 
+/** CPL Reel node */   
 class Reel : public XMLNode
 {
 public:
@@ -69,6 +97,7 @@ public:
        boost::shared_ptr<CPLAssetList> asset_list;
 };
 
+/** CPL ContentVersion node */ 
 class ContentVersion : public XMLNode
 {
 public:
@@ -79,9 +108,11 @@ public:
        std::string label_text;
 };
 
+/** Class to parse a CPL */
 class CPL : public XMLFile
 {
 public:
+       /** Parse a CPL XML file into our member variables */
        CPL (std::string file);
 
        std::string id;

diff --git a/src/pkl.cc b/src/pkl.cc
index 0ede1d57e08eafd3c6a46cfb4b8539744f6d57f3..51e75818c2b57b5760c1acf49b970be788ba600d 100644 (file)
--- a/src/pkl.cc
+++ b/src/pkl.cc
@@ -1,3 +1,26 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/cpl.cc
+ *  @brief Classes used to parse a PKL.
+ */
+
 #include <iostream>
 #include "pkl.h"
 

diff --git a/src/pkl.h b/src/pkl.h
index 8c64f43bb55a39d42739b5dc7347fd6c1296eea2..ed1bcd61fcf6c9f6dac1daba208738c85227681f 100644 (file)
--- a/src/pkl.h
+++ b/src/pkl.h
@@ -1,3 +1,26 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/pkl.h
+ *  @brief Classes used to parse a PKL
+ */
+
 #include <boost/shared_ptr.hpp>
 #include "xml.h"