Some comments.

4 files changed, 50 insertions, 6 deletions

diff --git a/src/dcp.h b/src/dcp.h
index 60135c2e..fb3bd751 100644
--- a/src/dcp.h
+++ b/src/dcp.h
@@ -51,6 +51,9 @@ class DCP
 {
 public:
 	/** Construct a DCP.
+	 *
+	 *  This is for making a new DCP that you are going to add assets to.
+	 *
 	 *  @param directory Directory to write files to.
 	 *  @param name Name.
 	 *  @param content_kind Content kind.
@@ -59,6 +62,13 @@ public:
 	 */
 	DCP (std::string directory, std::string name, ContentKind content_kind, int fps, int length);
 
+	/** Construct a DCP object for an existing DCP.
+	 *
+	 *  The DCP's XML metadata will be examined, and you can then look at the contents
+	 *  of the DCP.
+	 *
+	 *  @param directory Existing DCP's directory.
+	 */
 	DCP (std::string directory);
 
 	/** Add a sound asset.
@@ -93,26 +103,43 @@ public:
 	 */
 	void write_xml () const;
 
+	/** @return the DCP's name, as will be presented on projector
+	 *  media servers and theatre management systems.
+	 */
 	std::string name () const {
 		return _name;
 	}
 
+	/** @return the type of the content, used by media servers
+	 *  to categorise things (e.g. feature, trailer, etc.)
+	 */
 	ContentKind content_kind () const {
 		return _content_kind;
 	}
 
+	/** @return the number of frames per second */
 	int frames_per_second () const {
 		return _fps;
 	}
 
+	/** @return the length in frames */
 	int length () const {
 		return _length;
 	}
 
+	/** @return the main picture asset, if one exists, otherwise 0 */
 	boost::shared_ptr<const PictureAsset> picture_asset () const;
+	/** @return the main sound asset, if one exists, otherwise 0 */
 	boost::shared_ptr<const SoundAsset> sound_asset () const;
+	/** @return the main subtitle asset, if one exists, otherwise 0 */
 	boost::shared_ptr<const SubtitleAsset> subtitle_asset () const;
 
+	/** Compare this DCP with another, according to various options.
+	 *  @param other DCP to compare this one to.
+	 *  @param options Options to define just what "equality" means.
+	 *  @return An empty list if the DCPs are equal; otherwise a list of messages
+	 *  which explain the ways in which they differ.
+	 */
 	std::list<std::string> equals (DCP const & other, EqualityOptions options) const;
 
 	/** Emitted with a parameter between 0 and 1 to indicate progress
diff --git a/src/dcp_time.cc b/src/dcp_time.cc
index f853143a..900d7c6e 100644
--- a/src/dcp_time.cc
+++ b/src/dcp_time.cc
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/dcp_time.cc
+ *  @brief A representation of time within a DCP.
+ */
+
 #include <iostream>
 #include <cmath>
 #include "dcp_time.h"
diff --git a/src/dcp_time.h b/src/dcp_time.h
index a611cd89..626cdaca 100644
--- a/src/dcp_time.h
+++ b/src/dcp_time.h
@@ -17,16 +17,29 @@
 
 */
 
+/** @file  src/dcp_time.h
+ *  @brief A representation of time within a DCP.
+ */
+
 #ifndef LIBDCP_TIME_H
 #define LIBDCP_TIME_H
 
 namespace libdcp {
 
+/** @class Time
+ *  @brief A representation of time within a DCP.
+ */
+	
 class Time
 {
 public:
 	Time () : h (0), m (0), s (0), t (0) {}
+
+	/** Construct a Time from a frame index (starting from 0)
+	 *  and a frames per second count.
+	 */
 	Time (int frame, int frames_per_second);
+	
 	Time (int h_, int m_, int s_, int t_)
 		: h (h_)
 		, m (m_)
@@ -34,10 +47,10 @@ public:
 		, t (t_)
 	{}
 
-	int h;
-	int m;
-	int s;
-	int t;
+	int h; ///< hours
+	int m; ///< minutes
+	int s; ///< seconds
+	int t; ///< `ticks', where 1 tick is 4 milliseconds
 };
 
 extern bool operator== (Time const & a, Time const & b);
diff --git a/src/mxf_asset.h b/src/mxf_asset.h
index 35509311..d01d091d 100644
--- a/src/mxf_asset.h
+++ b/src/mxf_asset.h
@@ -30,12 +30,12 @@ class MXFAsset : public Asset
 public:
 	/** Construct an MXFAsset.
 	 *  @param directory Directory where MXF file is.
-	 *  @param mxf_name Name of MXF file.
+	 *  @param file_name Name of MXF file.
 	 *  @param progress Signal to inform of progress.
 	 *  @param fps Frames per second.
 	 *  @param length Length in frames.
 	 */
-	MXFAsset (std::string directory, std::string mxf_path, sigc::signal1<void, float>* progress, int fps, int length);
+	MXFAsset (std::string directory, std::string file_name, sigc::signal1<void, float>* progress, int fps, int length);
 
 	virtual std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityOptions opt) const;