From 5d9c51436fe44785dec918af133c9f2e09d5d8d0 Mon Sep 17 00:00:00 2001
From: Carl Hetherington <cth@carlh.net>
Date: Wed, 22 Aug 2012 19:14:33 +0100
Subject: Use make_dcp example in documentation.

---
 examples/make_dcp.cc | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

(limited to 'examples/make_dcp.cc')

diff --git a/examples/make_dcp.cc b/examples/make_dcp.cc
index 41026cc2..5b764393 100644
--- a/examples/make_dcp.cc
+++ b/examples/make_dcp.cc
@@ -17,13 +17,20 @@
 
 */
 
-/* This example file shows how to make a DCP from some JPEG2000 and WAV files
-   using libdcp.
-*/
+/** @file examples/make_dcp.cc
+ *  @brief Shows how to make a DCP from some JPEG2000 and WAV files.
+ */
 
 #include <vector>
 #include <string>
 #include <sigc++/sigc++.h>
+
+/* If you are using an installed libdcp, these #includes would need to be changed to
+#include <libdcp/dcp.h>
+#include <libdcp/picture_asset.h>
+... etc. ...
+*/
+
 #include "dcp.h"
 #include "picture_asset.h"
 #include "sound_asset.h"
@@ -67,6 +74,14 @@ main ()
 
 	/* Now we will create a `sound asset', which is made up of a WAV file for each channel of audio.  Here we're using
 	   stereo, so we add two WAV files to a vector.
+
+	   We could add more files here to use more channels; the file order is:
+	       Left
+	       Right
+	       Centre
+	       LFE (sub)
+	       Left surround
+	       Right surround
 	*/
 	std::vector<std::string> sound_files;
 	sound_files.push_back ("examples/sine_440_-12dB.wav");
-- 
cgit v1.2.3