Doxygen tweaks.

17 files changed, 49 insertions, 29 deletions

diff --git a/test/.gitignore b/test/.gitignore
new file mode 100644
index 000000000..0e74f6e1c
--- /dev/null
+++ b/test/.gitignore
@@ -0,0 +1,3 @@
+README.aux
+README.log
+README.pdf
diff --git a/test/README.tex b/test/README.tex
index bbe606879..89a598832 100644
--- a/test/README.tex
+++ b/test/README.tex
@@ -50,31 +50,31 @@ The files in this directory can be grouped roughly into the following:
 
 \subsection{Tests of fairly specific areas}
 
-\begin{tabular}{|l|l|}
+\begin{tabular}{|l|p{8cm}|}
   \hline
-  \textbf{File} & \textbf{Summary} \\
+  \textbf{File} & \textbf{Test summary} \\
   \hline
-\item \co{audio\_delay\_test} &
+  \co{audio\_delay\_test} & Some FFmpeg content with audio delays. \\
   \hline
-\item \co{client\_server\_test}
+  \co{client\_server\_test} & An encode server running on \co{localhost}. \\
   \hline
-\item \co{digest\_test}
+  \co{digest\_test} & Computed DCP digests compared to those calculated by the \co{openssl} binary. \\
   \hline
-\item \co{film\_metadata\_test}
+  \co{film\_metadata\_test} & Read/write of \co{Film} metadata. \\
   \hline
-\item \co{frame\_rate\_test}
+  \co{frame\_rate\_test} & Frame rate conversion calculations. \\
   \hline
-\item \co{recover\_test}
+  \co{recover\_test} & Re-making a DCP when a previous run was interrupted. \\
   \hline
-\item \co{repeat\_frame\_test}
+  \co{repeat\_frame\_test} & Repetition of 24fps content in a 48fps DCP. \\
   \hline
-\item \co{scaling\_test}
+  \co{scaling\_test} & Scaling and black-padding of images. \\
   \hline
-\item \co{silence\_padding\_test}
+  \co{silence\_padding\_test} & \\
   \hline
-\item \co{skip\_frame\_test}
+  \co{skip\_frame\_test} & \\
   \hline
-\end{itemize}
+\end{tabular}
 
 \subsubsection{FFmpeg decoding}
 
diff --git a/test/audio_analysis_test.cc b/test/audio_analysis_test.cc
index ae5fd0834..66c577579 100644
--- a/test/audio_analysis_test.cc
+++ b/test/audio_analysis_test.cc
@@ -18,8 +18,11 @@
 
 */
 
+/** @defgroup selfcontained Self-contained tests of single classes / method sets */
+
 /** @file  test/audio_analysis_test.cc
- *  @brief Check audio analysis code.
+ *  @brief Test AudioAnalysis class.
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
diff --git a/test/audio_buffers_test.cc b/test/audio_buffers_test.cc
index c9231ae7f..921592f55 100644
--- a/test/audio_buffers_test.cc
+++ b/test/audio_buffers_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/audio_buffers_test.cc
- *  @brief Test AudioBuffers in various ways.
+ *  @brief Test AudioBuffers class.
+ *  @ingroup selfcontained
  */
 
 #include <cmath>
diff --git a/test/audio_filter_test.cc b/test/audio_filter_test.cc
index b92d005a5..b0bb1449c 100644
--- a/test/audio_filter_test.cc
+++ b/test/audio_filter_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/audio_filter_test.cc
- *  @brief Basic tests of audio filters.
+ *  @brief Test AudioFilter, LowPassAudioFilter, HighPassAudioFilter classes.
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
diff --git a/test/audio_mapping_test.cc b/test/audio_mapping_test.cc
index adf715fc4..131031381 100644
--- a/test/audio_mapping_test.cc
+++ b/test/audio_mapping_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/audio_mapping_test.cc
- *  @brief Basic tests of the AudioMapping class, which itself doesn't really do much.
+ *  @brief Test AudioMapping class.
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
diff --git a/test/audio_merger_test.cc b/test/audio_merger_test.cc
index 2b6cdc267..1484213e7 100644
--- a/test/audio_merger_test.cc
+++ b/test/audio_merger_test.cc
@@ -18,6 +18,11 @@
 
 */
 
+/** @file  test/audio_merger_test.cc
+ *  @brief Test AudioMerger class.
+ *  @ingroup selfcontained
+ */
+
 #include "lib/audio_merger.h"
 #include "lib/audio_buffers.h"
 #include <boost/test/unit_test.hpp>
diff --git a/test/colour_conversion_test.cc b/test/colour_conversion_test.cc
index 03b89dee0..94284f879 100644
--- a/test/colour_conversion_test.cc
+++ b/test/colour_conversion_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/colour_conversion_test.cc
- *  @brief Various tests of ColourConversion.
+ *  @brief Test ColourConversion class.
+ *  @ingroup selfcontained
  */
 
 #include "lib/colour_conversion.h"
diff --git a/test/file_group_test.cc b/test/file_group_test.cc
index e0f83f631..cfcaacfc2 100644
--- a/test/file_group_test.cc
+++ b/test/file_group_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/file_group_test.cc
- *  @brief Check that FileGroup works.
+ *  @brief Test FileGroup class.
+ *  @ingroup selfcontained
  */
 
 #include <stdint.h>
diff --git a/test/image_test.cc b/test/image_test.cc
index d00263035..5a39bb066 100644
--- a/test/image_test.cc
+++ b/test/image_test.cc
@@ -19,8 +19,8 @@
 */
 
 /** @file  test/image_test.cc
- *  @brief Tests of the Image class.
- *
+ *  @brief Test Image class.
+ *  @ingroup selfcontained
  *  @see test/make_black_test.cc, test/pixel_formats_test.cc
  */
 
diff --git a/test/job_test.cc b/test/job_test.cc
index 8728b7312..f4c9658bf 100644
--- a/test/job_test.cc
+++ b/test/job_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/job_test.cc
- *  @brief Basic tests of Job and JobManager.
+ *  @brief Test Job and JobManager.
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
diff --git a/test/make_black_test.cc b/test/make_black_test.cc
index 405cc835f..2ed5db8ef 100644
--- a/test/make_black_test.cc
+++ b/test/make_black_test.cc
@@ -19,9 +19,9 @@
 */
 
 /** @file  test/make_black_test.cc
- *  @brief Check that Image::make_black works, and doesn't use values which crash
+ *  @brief Check that Image::make_black works and doesn't use values which crash
  *  sws_scale().
- *
+ *  @ingroup selfcontained
  *  @see test/image_test.cc
  */
 
diff --git a/test/pixel_formats_test.cc b/test/pixel_formats_test.cc
index 46e7193e2..952cc0af9 100644
--- a/test/pixel_formats_test.cc
+++ b/test/pixel_formats_test.cc
@@ -21,7 +21,7 @@
 /** @file  src/pixel_formats_test.cc
  *  @brief Make sure that Image::sample_size() and Image::bytes_per_pixel() return the right
  *  things for various pixel formats.
- *
+ *  @ingroup selfcontained
  *  @see test/image_test.cc
  */
 
diff --git a/test/player_test.cc b/test/player_test.cc
index 81d1f4cce..4e6941294 100644
--- a/test/player_test.cc
+++ b/test/player_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/player_test.cc
- *  @brief Various tests of Player.
+ *  @brief Test Player class.
+ *  @ingroup selfcontained
  */
 
 #include <iostream>
diff --git a/test/ratio_test.cc b/test/ratio_test.cc
index c56906348..573e8899e 100644
--- a/test/ratio_test.cc
+++ b/test/ratio_test.cc
@@ -19,7 +19,8 @@
 */
 
 /** @file  test/ratio_test.cc
- *  @brief Test Ratio and fit_ratio_within().
+ *  @brief Test Ratio class and fit_ratio_within().
+ *  @ingroup selfcontained
  */
 
 #include <iostream>
@@ -66,4 +67,3 @@ BOOST_AUTO_TEST_CASE (ratio_test)
 	BOOST_CHECK (r);
 	BOOST_CHECK_EQUAL (fit_ratio_within (r->ratio(), dcp::Size (2048, 1080)), dcp::Size (2048, 1080));
 }
-
diff --git a/test/resampler_test.cc b/test/resampler_test.cc
index 6f3e3fef1..893fad3b5 100644
--- a/test/resampler_test.cc
+++ b/test/resampler_test.cc
@@ -19,8 +19,9 @@
 */
 
 /** @file  test/resampler_test.cc
- *  @brief Check that the timings that come back from the resampler correspond
+ *  @brief Check that the timings that come back from Resampler correspond
  *  to the number of samples it generates.
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
diff --git a/test/util_test.cc b/test/util_test.cc
index 334811cb7..b071708b3 100644
--- a/test/util_test.cc
+++ b/test/util_test.cc
@@ -20,6 +20,7 @@
 
 /** @file  test/util_test.cc
  *  @brief Test various utility methods.
+ *  @ingroup selfcontained
  */
 
 #include "lib/util.h"