Some tidying up of test Doxygen.
authorCarl Hetherington <cth@carlh.net>
Fri, 20 Nov 2020 21:53:10 +0000 (22:53 +0100)
committerCarl Hetherington <cth@carlh.net>
Fri, 20 Nov 2020 21:57:39 +0000 (22:57 +0100)
41 files changed:
test/audio_delay_test.cc
test/audio_processor_test.cc
test/burnt_subtitle_test.cc
test/client_server_test.cc
test/dcp_subtitle_test.cc
test/dcpomatic_time_test.cc
test/digest_test.cc
test/empty_test.cc
test/ffmpeg_audio_only_test.cc
test/ffmpeg_audio_test.cc
test/ffmpeg_dcp_test.cc
test/ffmpeg_decoder_seek_test.cc
test/ffmpeg_decoder_sequential_test.cc
test/ffmpeg_examiner_test.cc
test/ffmpeg_pts_offset_test.cc
test/file_naming_test.cc
test/film_metadata_test.cc
test/frame_rate_test.cc
test/import_dcp_test.cc
test/interrupt_encoder_test.cc
test/isdcf_name_test.cc
test/j2k_bandwidth_test.cc
test/recover_test.cc
test/rect_test.cc
test/reels_test.cc
test/render_subtitles_test.cc
test/repeat_frame_test.cc
test/required_disk_space_test.cc
test/scaling_test.cc
test/silence_padding_test.cc
test/skip_frame_test.cc
test/srt_subtitle_test.cc
test/ssa_subtitle_test.cc
test/time_calculation_test.cc
test/update_checker_test.cc
test/upmixer_a_test.cc
test/vf_kdm_test.cc
test/vf_test.cc
test/video_level_test.cc
test/video_mxf_content_test.cc
test/zipper_test.cc

index 8e1d820859fa458838acc144bf6970ed6098331b..2645cf5172a171170a7d957a4f373628d85b1387 100644 (file)
 
 */
 
-/** @defgroup specific Tests of fairly specific areas */
+/** @defgroup feature Tests of features */
 
 /** @file  test/audio_delay_test.cc
  *  @brief Test encode using some FFmpegContents which have audio delays.
- *  @ingroup specific
+ *  @ingroup feature
  *
  *  The output is checked algorithmically using knowledge of the input.
  */
index 4e917bd45bbad300c84e8bfcec3ee2bf0ec4b18f..d814ab42119eca9885d945654af2f908b9dd75d2 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/audio_processor_test.cc
  *  @brief Test audio processors.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/audio_processor.h"
index 8bd2c46b8684e8cfac4506e4c213ccda4b3060df..2a1360c78269b5962c08509eb15be62f036db284 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/burnt_subtitle_test.cc
  *  @brief Test the burning of subtitles into the DCP.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/plain_text_content.h"
index 22eeedbabe3f74f791d4a9126252d23d873ac7d3..e7ab5ec7acdeaeddb79649c0a22e2bc38134e3ab 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/client_server_test.cc
  *  @brief Test the server class.
- *  @ingroup specific
+ *  @ingroup feature
  *
  *  Create a test image and then encode it using the standard mechanism
  *  and also using a EncodeServer object running on localhost.  Compare the resulting
index 4938cfb6dc1ee4759f54a1b9d53f94e562954fd7..f7e7fe795b56f954bec6c416f45ba93ba8afa32e 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/dcp_subtitle_test.cc
  *  @brief Test DCP subtitle content in various ways.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include <boost/test/unit_test.hpp>
index b343a1376b608bc4bef4581354504546ec49eca0..e4383b5396ab8fde9f9955ce3a86be58823f81ff 100644 (file)
@@ -19,7 +19,7 @@
 */
 
 /** @file  test/dcpomatic_time_test.cc
- *  @brief Test Time and TimePeriod classes.
+ *  @brief Test dcpomatic::Time and dcpomatic::TimePeriod classes.
  *  @ingroup selfcontained
  */
 
index 5fee9e7346bd9c02ff978383570c1672b7f9a941..b1effc9061ba13f261811d9200f4d64c36fe2390 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/digest_test.cc
  *  @brief Check computed DCP digests against references calculated by the `openssl` binary.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index 7b374ba49e9b8dd0d5938a119dc443c0fa4decf3..9a1f98ed28f4dd4f8bf459aa3fe97121ae70eacb 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/empty_test.cc
  *  @brief Test the creation of Empty objects.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index 13b25e1a89dadd4e610c80316c7a7b592ed0ae2b..5e2c130a50991a0f247e5035f125d819da2a8949 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/ffmpeg_audio_only_test.cc
  *  @brief Test FFmpeg content with audio but no video.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index e4c9077154484b2672aca56a20a3bea887cc99d9..a54ffa0811f8d11850c51426ed43ce43e1dad271 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/ffmpeg_audio_test.cc
  *  @brief Test reading audio from an FFmpeg file.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/ffmpeg_content.h"
index ad09e5e1ae38029061eaba04fba7139f105df315..8de8feeba2c6e9da64c9141f0fcf815ef57eae33 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file test/ffmpeg_dcp_test.cc
  *  @brief Test creation of a very simple DCP from some FFmpegContent (data/test.mp4).
- *  @ingroup specific
+ *  @ingroup feature
  *
  *  Also a quick test of Film::have_dcp ().
  */
index 230c5476869c9aa70632be3b59f47ac1e152b142..33b407a97414ad0bda53a9efa7c2b57d60ffdd56 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/ffmpeg_decoder_seek_test.cc
  *  @brief Check seek() with FFmpegDecoder.
- *  @ingroup specific
+ *  @ingroup selfcontained
  *
  *  This doesn't check that the contents of those frames are right, which
  *  it probably should.
index b4ff8ce5fd4b2369b862164ae85cdf88a93af16a..bf66685867117421651f93e8ffeff186c34a576c 100644 (file)
@@ -21,7 +21,7 @@
 /** @file  test/ffmpeg_decoder_sequential_test.cc
  *  @brief Check that the FFmpeg decoder and Player produce sequential frames without gaps or dropped frames;
  *  Also that the decoder picks up frame rates correctly.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/ffmpeg_content.h"
index 04e6f25356a53174e1c52f99fba3c83c6cd717aa..fbc3e51f0d9f3af0bc068213837d7b6f3dec283f 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/ffmpeg_examiner_test.cc
  *  @brief FFmpegExaminer tests
- *  @ingroup specific
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
index f4bf6df3525d7053aa648ecbd24c17f8dca2935a..35996f01a49a8365be1a106341f6f913bbfe6e09 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/ffmpeg_pts_offset_test.cc
  *  @brief Check the computation of _pts_offset in FFmpegDecoder.
- *  @ingroup specific
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
index d0db2f30a4a05743e403d6644a2b29174eeee835..ebc89d6b1130e3aec55abfbb3ad25dc10bfa52b0 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/file_naming_test.cc
  *  @brief Test how files in DCPs are named.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "test.h"
index 854d3e6eae376be76164468f01d03703d4987d35..6af4b7ffea4b225186525f7e44a29e3390f5e4aa 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/film_metadata_test.cc
  *  @brief Test some basic reading/writing of film metadata.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include <boost/test/unit_test.hpp>
index 292dff8dbb05b2b290cb152e326023d9f9120b89..2a0aa9415546386e74eaade3d75226fdad96bc56 100644 (file)
@@ -21,7 +21,7 @@
 /** @file  test/frame_rate_test.cc
  *  @brief Tests for FrameRateChange and the computation of the best
  *  frame rate for the DCP.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include <boost/test/unit_test.hpp>
index 2f33f93f55c3f66c3dada323cdcbe9823a6397ee..671fc8cf7eb8136e37be917e75e0a10a7ae0b0c5 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/import_dcp_test.cc
  *  @brief Test import of encrypted DCPs.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "test.h"
index 584f82987b4db09e6e4ee07936558d4b67155d37..85428e7d337cc0f3343a811f89e1deb21e327b80 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/interrupt_encoder_test.cc
  *  @brief Test clean shutdown of threads if a DCP encode is interrupted.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index bdb21bfccc42a034b2be7035c842d4fa2643c311..b88afb0a052329d43cf2bb27c2bb7e9932838c92 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/isdcf_name_test.cc
  *  @brief Test creation of ISDCF names.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include <boost/test/unit_test.hpp>
index 832f48c3f8cd6ac28a21068edc650d651a9db228..a1e6c1ac68bdf1989289c49820c4b27a5ab691de 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/bandwidth_test.cc
  *  @brief Test whether we output whatever J2K bandwidth is requested.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "test.h"
index 84e6a74e3984e96943ef6eaca52b83c1bf1c3f2a..01afa5e92b13406c0e174d965e4885d0514a83be 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/recover_test.cc
  *  @brief Test recovery of a DCP transcode after a crash.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "test.h"
index 832fdad823fca2a9c446164a81a8b16f63930bb8..f603b1230833232fa3a27b1b60002207b12de434 100644 (file)
@@ -19,7 +19,7 @@
 */
 
 /** @file  test/rect_test.cc
- *  @brief Test Rect class.
+ *  @brief Test dcpomatic::Rect class.
  *  @ingroup selfcontained
  */
 
index 573289718117ac12cb096b77274a8fd624e12c6d..01b2f9b4a08f7442bddaeb3f8b1dca2eab79374c 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/reels_test.cc
  *  @brief Check manipulation of reels in various ways.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index 29c6c9963575b949c29bcbe8012aa4ff8c1f0e54..99e1e7a1b11d531210aeb9b22e0536e3e73d61ff 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/render_text_test.cc
  *  @brief Check markup of subtitles for rendering.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/render_text.h"
index 358e6fe8f468c5f9f98a1a6dfc9bfd1ded932ddf..125f46686f73264fc7e8cc1329a18d1784619dbf 100644 (file)
@@ -21,7 +21,7 @@
 /** @file  test/repeat_frame_test.cc
  *  @brief Test the repeat of frames by the player when putting a 24fps
  *  source into a 48fps DCP.
- *  @ingroup specific
+ *  @ingroup feature
  *
  *  @see test/skip_frame_test.cc
  */
index 6a177fd712b6d07d9685d6cc8692ed64ff2758a7..d1ff82ca62c3f75553f18f0f70d8e7985ef15a2c 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/required_disk_space_test.cc
  *  @brief Check Film::required_disk_space
- *  @ingroup specific
+ *  @ingroup selfcontained
  */
 
 #include "lib/content_factory.h"
index dd3b6118ecf6eea8a76acd870d84c9788185a0bd..491b63723f8d2e725cda848390cdcdfe8a3335cc 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file test/scaling_test.cc
  *  @brief Test scaling and black-padding of images from a still-image source.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include <boost/test/unit_test.hpp>
index 75abd02845d97030b4c9faff1bd5fe4552edb81b..9c432d3e2c738147b03e67ca1639af11b526e815 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/silence_padding_test.cc
  *  @brief Test the padding (with silence) of a mono source to a 6-channel DCP.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/ffmpeg_content.h"
index aea389ce301f735c3849e6bd212b8a3e34d973ba..4b137c9917d10a0f592597bf41f034d7fe7784ed 100644 (file)
@@ -21,7 +21,7 @@
 /** @file  test/skip_frame_test.cc
  *  @brief Test the skip of frames by the player when putting a 48fps
  *  source into a 24fps DCP.
- *  @ingroup specific
+ *  @ingroup feature
  *
  *  @see test/repeat_frame_test.cc
  */
index 5fbe3058deb851f8966e0f81c97fce882fad8358..1ea4538ba258a6ef55bda49e66bbdd17909333a2 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/srt_subtitle_test.cc
  *  @brief Test writing DCPs with subtitles from .srt.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index bb37358f1e4041ead825f2eeb198b451ab879a31..c07666aa04469e49aeb66a499028c96dc1dddd49 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/ssa_subtitle_test.cc
  *  @brief Test use of SSA subtitle files.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index ed4440b33c6f244979cdfc4ffedbdc97a0ae3a80..8c57a9fdbbb3dfdb4b417ea12eb1bcc813f65231 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/time_calculation_test.cc
  *  @brief Test calculation of timings when frame rates change.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index 77266577215c576f530ec95cf57eb46a07e6add8..27754f0dd4f9318f63d357ca0dd687bfba04adbf 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/update_checker_test.cc
  *  @brief Check UpdateChecker::version_less_than
- *  @ingroup specific
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
index 2d1e652229cf2413adda872b9fc4d50693e2ae82..085a0dd0417435cf923c7d026bd8f683c47b1826 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/upmixer_a_test.cc
  *  @brief Check the Upmixer A against some reference sound files.
- *  @ingroup specific
+ *  @ingroup selfcontained
  */
 
 #include <boost/test/unit_test.hpp>
index f37742c038aacdc20272f67d04c20ce0701b0813..5d16e3be5795efbf571bbd6743232950ebbd5aa6 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/vf_kdm_test.cc
  *  @brief Test encrypted VF creation and import
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "test.h"
index e0d328447081846ef13aa1f978abfdb31729635d..ad4bcf8a409fe08c7a86f87b7fa48873e10ea81a 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/vf_Test.cc
  *  @brief Various VF-related tests.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index b584263fcec79f2be46be3120ac45575f1dcdd5b..4ae722e7cd99f85d6148c6c87601d6eeb124d244 100644 (file)
@@ -21,7 +21,7 @@
 
 /** @file  test/video_level_test.cc
  *  @brief Test that video level ranges are handled correctly.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 
index 7ce3201df5aa6a5fe1b699e90217125b2778bcf8..91d03778cef13b05af216cc85d6c28d3f226a436 100644 (file)
@@ -20,7 +20,7 @@
 
 /** @file  test/video_mxf_content_test.cc
  *  @brief Test use of Video MXF content.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
 #include "lib/film.h"
index 10ffd76a4fc5bbe3d7623e44895a73e02f9a9129..1ec7ff80b9e74398fd13fc1af533542e3bfb29d2 100644 (file)
@@ -19,7 +19,7 @@
 */
 
 /** @file  test/zipper_test.cc
- *  @brief Tests of Zipper class.
+ *  @brief Test Zipper class.
  *  @ingroup selfcontained
  */