Some doc fixes.

8 files changed, 35 insertions, 16 deletions

diff --git a/Doxyfile b/Doxyfile
index 4ed65e4f1..9dc348635 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -661,7 +661,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = src/lib src/wx src/tools \
+INPUT                  = src/lib src/wx src/tools test \
                          doc/mainpage.txt
 
 # This tag can be used to specify the character encoding of the source files
diff --git a/doc/mainpage.txt b/doc/mainpage.txt
index 649c9c609..a1cd9bac8 100644
--- a/doc/mainpage.txt
+++ b/doc/mainpage.txt
@@ -1,7 +1,7 @@
 /** @mainpage DCP-o-matic
  *
  *  DCP-o-matic is a tool to create digital cinema packages (DCPs) from
- *  video files, or from sets of TIFF image files.  It is written in C++
+ *  video files, or from sets of image files.  It is written in C++
  *  and distributed under the GPL.
  *
  *  Video files are decoded using FFmpeg (http://ffmpeg.org), so any video
@@ -26,12 +26,8 @@
  *  for debugging purposes.
  *
  *  Thanks are due to the authors and communities of all DCP-o-matic's dependencies.
- * 
- *  DCP-o-matic is distributed in the hope that there are still cinemas with projectionists
- *  who might want to use it.  As Mark Kermode says, "if it doesn't have a projectionist
- *  it's not a cinema - it's a sweetshop with a video-screen."
  *
- *  Email correspondance is welcome to cth@carlh.net
+ *  Email correspondance is welcome to carl@dcpomatic.com
  *
- *  More details can be found at http://carlh.net/software/dcpomatic
+ *  More details can be found at http://dcpomatic.com/
  */
diff --git a/test/4k_test.cc b/test/4k_test.cc
index f2892c5a3..1e0b42697 100644
--- a/test/4k_test.cc
+++ b/test/4k_test.cc
@@ -17,6 +17,12 @@
 
 */
 
+/** @file  test/4k_test.cc
+ *  @brief Run a 4K encode from a simple input.
+ *
+ *  The output is checked against test/data/4k_test.
+ */
+
 #include <boost/test/unit_test.hpp>
 #include "lib/film.h"
 #include "lib/ffmpeg_content.h"
diff --git a/test/audio_analysis_test.cc b/test/audio_analysis_test.cc
index b94b12056..13a8dac84 100644
--- a/test/audio_analysis_test.cc
+++ b/test/audio_analysis_test.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-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,6 +17,10 @@
 
 */
 
+/** @file  test/audio_analysis_test.cc
+ *  @brief Check serialisation of audio analyses.
+ */
+
 #include <boost/test/unit_test.hpp>
 #include "lib/audio_analysis.h"
 
@@ -26,7 +30,6 @@ random_float ()
 	return (float (rand ()) / RAND_MAX) * 2 - 1;
 }
 
-/* Check serialisation of audio analyses */
 BOOST_AUTO_TEST_CASE (audio_analysis_test)
 {
 	int const channels = 3;
diff --git a/test/audio_delay_test.cc b/test/audio_delay_test.cc
index 2e02fa999..8f4ca836a 100644
--- a/test/audio_delay_test.cc
+++ b/test/audio_delay_test.cc
@@ -17,6 +17,12 @@
 
 */
 
+/** @file  test/audio_delay_test.cc
+ *  @brief Test encode using some SndfileContents which have audio delays.
+ *
+ *  The output is checked algorithmically using knowledge of the input.
+ */
+
 #include <boost/test/unit_test.hpp>
 #include <dcp/sound_frame.h>
 #include <dcp/cpl.h>
@@ -87,7 +93,6 @@ void test_audio_delay (int delay_in_ms)
 	}
 }
 
-
 /* Test audio delay when specified in a piece of audio content */
 BOOST_AUTO_TEST_CASE (audio_delay_test)
 {
diff --git a/test/audio_mapping_test.cc b/test/audio_mapping_test.cc
index 1fc20dcaf..f8467f3de 100644
--- a/test/audio_mapping_test.cc
+++ b/test/audio_mapping_test.cc
@@ -17,13 +17,14 @@
 
 */
 
+/** @file  test/audio_mapping_test.cc
+ *  @brief Basic tests of the AudioMapping class, which itself doesn't really do much.
+ */
+
 #include <boost/test/unit_test.hpp>
 #include "lib/audio_mapping.h"
 #include "lib/util.h"
 
-/* Basic tests of the AudioMapping class, which itself
-   doesn't really do much.
-*/
 BOOST_AUTO_TEST_CASE (audio_mapping_test)
 {
 	AudioMapping none;
diff --git a/test/black_fill_test.cc b/test/black_fill_test.cc
index a7e44bdfb..ef768b9a4 100644
--- a/test/black_fill_test.cc
+++ b/test/black_fill_test.cc
@@ -25,7 +25,7 @@
 #include "test.h"
 
 /** @file test/black_fill_test.cc
- *  @brief Test insertion of black frames between video content.
+ *  @brief Test insertion of black frames between separate bits of video content.
  */
 
 using boost::shared_ptr;
diff --git a/test/client_server_test.cc b/test/client_server_test.cc
index 54bbd520f..3faf3e74c 100644
--- a/test/client_server_test.cc
+++ b/test/client_server_test.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-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,6 +17,14 @@
 
 */
 
+/** @file  test/client_server_test.cc
+ *  @brief Test the server class.
+ *
+ *  Create a test image and then encode it using the standard mechanism
+ *  and also using a Server object running on localhost.  Compare the resulting
+ *  encoded data to check that they are the same.
+ */
+
 #include <boost/test/unit_test.hpp>
 #include <boost/thread.hpp>
 #include "lib/server.h"