From 39f0ae0efb3406357253d19bf7588f3832735d0b Mon Sep 17 00:00:00 2001
From: Carl Hetherington <cth@carlh.net>
Date: Wed, 15 Jan 2014 09:28:57 +0000
Subject: Comments.

---
 src/mono_picture_asset.h | 12 ++++++++++++
 src/mxf_asset.h          |  3 +++
 src/picture_asset.h      |  5 +++++
 src/sound_asset.h        | 16 ++++++++++++++++
 4 files changed, 36 insertions(+)

(limited to 'src')

diff --git a/src/mono_picture_asset.h b/src/mono_picture_asset.h
index d2029e00..ae2df4d2 100644
--- a/src/mono_picture_asset.h
+++ b/src/mono_picture_asset.h
@@ -31,7 +31,19 @@ public:
 	MonoPictureAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name);
 
 	void read ();
+
+	/** The following parameters must be set up (if required) before calling this:
+	 *      Interop mode (set_interop)
+	 *      Edit rate    (set_edit_rate)
+	 *      MXF Metadata (set_metadata)
+	 */
 	void create (std::vector<boost::filesystem::path> const & files);
+
+	/** The following parameters must be set up (if required) before calling this:
+	 *      Interop mode (set_interop)
+	 *      Edit rate    (set_edit_rate)
+	 *      MXF Metadata (set_metadata)
+	 */
 	void create (boost::function<boost::filesystem::path (int)> get_path);
 
 	/** Start a progressive write to a MonoPictureAsset */
diff --git a/src/mxf_asset.h b/src/mxf_asset.h
index dda69a9a..68445425 100644
--- a/src/mxf_asset.h
+++ b/src/mxf_asset.h
@@ -94,6 +94,9 @@ public:
 		return _metadata;
 	}
 
+	/** Set whether or not the asset should be written in Interop mode.
+	 *  @param i true to use interop.
+	 */
 	void set_interop (bool i) {
 		_interop = i;
 	}
diff --git a/src/picture_asset.h b/src/picture_asset.h
index e08efb1d..a11c286c 100644
--- a/src/picture_asset.h
+++ b/src/picture_asset.h
@@ -54,6 +54,11 @@ public:
 	PictureAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name);
 
 	/** Start a progressive write to this asset.
+	 *  The following parameters must be set up (if required) before calling this:
+	 *      Interop mode (set_interop)
+	 *      Edit rate    (set_edit_rate)
+	 *      MXF Metadata (set_metadata)
+	 *      
 	 *  @param overwrite true to overwrite an existing MXF file; in this mode, writing can be resumed to a partially-written MXF; false if the
 	 *  MXF file does not exist.
 	 */
diff --git a/src/sound_asset.h b/src/sound_asset.h
index 43587a9a..d2e49bd1 100644
--- a/src/sound_asset.h
+++ b/src/sound_asset.h
@@ -71,7 +71,23 @@ public:
 	SoundAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name);
 
 	void read ();
+
+	/** The following parameters must be set up (if required) before calling this:
+	 *      Interop mode (set_interop)
+	 *      Edit rate    (set_edit_rate)
+	 *      MXF Metadata (set_metadata)
+	 *      Channels     (set_channels)
+	 *      Intrinsic duration (set_intrinsic_duration)
+	 */
 	void create (std::vector<boost::filesystem::path> const & files);
+
+	/** The following parameters must be set up (if required) before calling this:
+	 *      Interop mode (set_interop)
+	 *      Edit rate    (set_edit_rate)
+	 *      MXF Metadata (set_metadata)
+	 *      Channels     (set_channels)
+	 *      Intrinsic duration (set_intrinsic_duration)
+	 */
 	void create (boost::function<boost::filesystem::path (Channel)> get_path);
 
 	boost::shared_ptr<SoundAssetWriter> start_write ();
-- 
cgit v1.2.3