diff options
| author | Carl Hetherington <cth@carlh.net> | 2017-03-02 15:37:13 +0000 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2017-04-19 23:04:32 +0100 |
| commit | 67a68bd971ebe1b35daa3f75873b4ccb53c00ba0 (patch) | |
| tree | 9b1fea4070c3b15f346cc57075bbeed1b963329d /test | |
| parent | 3449bc0a6d6e77e851240a0953363f5a07ec6517 (diff) | |
Various Doxygen fixes.
Diffstat (limited to 'test')
45 files changed, 148 insertions, 3 deletions
diff --git a/test/4k_test.cc b/test/4k_test.cc index 033796ab2..e6e2cc7ce 100644 --- a/test/4k_test.cc +++ b/test/4k_test.cc @@ -18,8 +18,11 @@ */ +/** @defgroup completedcp Complete builds of DCPs with various characteristics, testing broad areas of code */ + /** @file test/4k_test.cc * @brief Run a 4K encode from a simple input. + * @ingroup completedcp * * The output is checked against test/data/4k_test. */ diff --git a/test/audio_delay_test.cc b/test/audio_delay_test.cc index 1d2d171db..db64bc7c8 100644 --- a/test/audio_delay_test.cc +++ b/test/audio_delay_test.cc @@ -18,8 +18,11 @@ */ +/** @defgroup specific Tests of fairly specific areas */ + /** @file test/audio_delay_test.cc * @brief Test encode using some FFmpegContents which have audio delays. + * @ingroup specific * * The output is checked algorithmically using knowledge of the input. */ diff --git a/test/audio_processor_delay_test.cc b/test/audio_processor_delay_test.cc index 78f8e6895..bb0538661 100644 --- a/test/audio_processor_delay_test.cc +++ b/test/audio_processor_delay_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/audio_processor_delay_test.cc + * @brief Test the AudioDelay class. + * @ingroup selfcontained + */ + #include "lib/audio_delay.h" #include "lib/audio_buffers.h" #include <boost/test/unit_test.hpp> diff --git a/test/audio_processor_test.cc b/test/audio_processor_test.cc index 82ae9e563..e3917af42 100644 --- a/test/audio_processor_test.cc +++ b/test/audio_processor_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/audio_processor_test.cc + * @brief Test audio processors. + * @ingroup specific + */ + #include "lib/audio_processor.h" #include "lib/analyse_audio_job.h" #include "lib/dcp_content_type.h" diff --git a/test/burnt_subtitle_test.cc b/test/burnt_subtitle_test.cc index e8c3f3597..054eddb31 100644 --- a/test/burnt_subtitle_test.cc +++ b/test/burnt_subtitle_test.cc @@ -20,6 +20,7 @@ /** @file test/burnt_subtitle_test.cc * @brief Test the burning of subtitles into the DCP. + * @ingroup specific */ #include "lib/text_subtitle_content.h" diff --git a/test/client_server_test.cc b/test/client_server_test.cc index e21f41c79..fab9411ab 100644 --- a/test/client_server_test.cc +++ b/test/client_server_test.cc @@ -20,6 +20,7 @@ /** @file test/client_server_test.cc * @brief Test the server class. + * @ingroup specific * * Create a test image and then encode it using the standard mechanism * and also using a EncodeServer object running on localhost. Compare the resulting diff --git a/test/dcp_subtitle_test.cc b/test/dcp_subtitle_test.cc index b1689a6cc..92a415ae1 100644 --- a/test/dcp_subtitle_test.cc +++ b/test/dcp_subtitle_test.cc @@ -20,6 +20,7 @@ /** @file test/dcp_subtitle_test.cc * @brief Test DCP subtitle content in various ways. + * @ingroup specific */ #include <boost/test/unit_test.hpp> diff --git a/test/dcpomatic_time_test.cc b/test/dcpomatic_time_test.cc index 7489e7a24..f49d29a57 100644 --- a/test/dcpomatic_time_test.cc +++ b/test/dcpomatic_time_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/dcpomatic_time_test.cc + * @brief Test Time and TimePeriod classes. + * @ingroup selfcontained + */ + #include "lib/dcpomatic_time.h" #include <boost/test/unit_test.hpp> #include <list> diff --git a/test/digest_test.cc b/test/digest_test.cc index 7395fe468..b96cb7ad7 100644 --- a/test/digest_test.cc +++ b/test/digest_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/digest_test.cc + * @brief Check computed DCP digests against references calculated by the `openssl` binary. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/image_content.h" #include "lib/dcp_content_type.h" diff --git a/test/ffmpeg_audio_only_test.cc b/test/ffmpeg_audio_only_test.cc index a7e2ca025..716cf5055 100644 --- a/test/ffmpeg_audio_only_test.cc +++ b/test/ffmpeg_audio_only_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/ffmpeg_audio_only_test.cc + * @brief Test FFmpeg content with audio but no video. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/ffmpeg_content.h" #include "lib/dcp_content_type.h" diff --git a/test/ffmpeg_audio_test.cc b/test/ffmpeg_audio_test.cc index 1e9048584..ec5752b9d 100644 --- a/test/ffmpeg_audio_test.cc +++ b/test/ffmpeg_audio_test.cc @@ -19,7 +19,8 @@ */ /** @file test/ffmpeg_audio_test.cc - * @brief A simple test of reading audio from an FFmpeg file. + * @brief Test reading audio from an FFmpeg file. + * @ingroup specific */ #include "lib/ffmpeg_content.h" diff --git a/test/ffmpeg_dcp_test.cc b/test/ffmpeg_dcp_test.cc index 748695efe..7cdecb22f 100644 --- a/test/ffmpeg_dcp_test.cc +++ b/test/ffmpeg_dcp_test.cc @@ -20,6 +20,7 @@ /** @file test/ffmpeg_dcp_test.cc * @brief Test creation of a very simple DCP from some FFmpegContent (data/test.mp4). + * @ingroup specific * * Also a quick test of Film::have_dcp (). */ diff --git a/test/ffmpeg_decoder_seek_test.cc b/test/ffmpeg_decoder_seek_test.cc index 46d82b022..26fab5f3d 100644 --- a/test/ffmpeg_decoder_seek_test.cc +++ b/test/ffmpeg_decoder_seek_test.cc @@ -20,6 +20,7 @@ /** @file test/ffmpeg_decoder_seek_test.cc * @brief Check seek() with FFmpegDecoder. + * @ingroup specific * * This doesn't check that the contents of those frames are right, which * it probably should. diff --git a/test/ffmpeg_decoder_sequential_test.cc b/test/ffmpeg_decoder_sequential_test.cc index 2fec7a37e..6bda8f260 100644 --- a/test/ffmpeg_decoder_sequential_test.cc +++ b/test/ffmpeg_decoder_sequential_test.cc @@ -21,6 +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 */ #include "lib/ffmpeg_content.h" diff --git a/test/ffmpeg_examiner_test.cc b/test/ffmpeg_examiner_test.cc index 411316089..0233db1f0 100644 --- a/test/ffmpeg_examiner_test.cc +++ b/test/ffmpeg_examiner_test.cc @@ -21,6 +21,7 @@ /** @file test/ffmpeg_examiner_test.cc * @brief Check that the FFmpegExaminer can extract the first video and audio time * correctly from data/count300bd24.m2ts. + * @ingroup specific */ #include <boost/test/unit_test.hpp> diff --git a/test/ffmpeg_pts_offset_test.cc b/test/ffmpeg_pts_offset_test.cc index f9371f74c..85a1e7844 100644 --- a/test/ffmpeg_pts_offset_test.cc +++ b/test/ffmpeg_pts_offset_test.cc @@ -20,6 +20,7 @@ /** @file test/ffmpeg_pts_offset_test.cc * @brief Check the computation of _pts_offset in FFmpegDecoder. + * @ingroup specific */ #include <boost/test/unit_test.hpp> diff --git a/test/file_log_test.cc b/test/file_log_test.cc index d7fe027d8..e0eeba010 100644 --- a/test/file_log_test.cc +++ b/test/file_log_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/file_log_test.cc + * @brief Test FileLog. + * @ingroup selfcontained + */ + #include "lib/file_log.h" #include <boost/test/unit_test.hpp> #include <iostream> diff --git a/test/file_naming_test.cc b/test/file_naming_test.cc index f4235dec2..8951f8380 100644 --- a/test/file_naming_test.cc +++ b/test/file_naming_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/file_naming_test.cc + * @brief Test how files in DCPs are named. + * @ingroup specific + */ + #include "test.h" #include "lib/config.h" #include "lib/film.h" diff --git a/test/film_metadata_test.cc b/test/film_metadata_test.cc index 4dfd6f2a5..3fd4ba9d1 100644 --- a/test/film_metadata_test.cc +++ b/test/film_metadata_test.cc @@ -20,6 +20,7 @@ /** @file test/film_metadata_test.cc * @brief Test some basic reading/writing of film metadata. + * @ingroup specific */ #include <boost/test/unit_test.hpp> diff --git a/test/frame_rate_test.cc b/test/frame_rate_test.cc index 592b7af8b..9521e3909 100644 --- a/test/frame_rate_test.cc +++ b/test/frame_rate_test.cc @@ -21,6 +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 */ #include <boost/test/unit_test.hpp> diff --git a/test/image_filename_sorter_test.cc b/test/image_filename_sorter_test.cc index 69f8c9ff1..113c24d10 100644 --- a/test/image_filename_sorter_test.cc +++ b/test/image_filename_sorter_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/image_filename_sorter_test.cc + * @brief Test ImageFilenameSorter + * @ingroup selfcontained + */ + #include "lib/image_filename_sorter.h" #include <boost/test/unit_test.hpp> diff --git a/test/import_dcp_test.cc b/test/import_dcp_test.cc index cd0396d07..163a3a4a9 100644 --- a/test/import_dcp_test.cc +++ b/test/import_dcp_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/import_dcp_test.cc + * @brief Test import of encrypted DCPs. + * @ingroup specific + */ + #include "test.h" #include "lib/film.h" #include "lib/dcp_subtitle_content.h" diff --git a/test/interrupt_encoder_test.cc b/test/interrupt_encoder_test.cc index 8883c2d6f..1068ed5b2 100644 --- a/test/interrupt_encoder_test.cc +++ b/test/interrupt_encoder_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/interrupt_encoder_test.cc + * @brief Test clean shutdown of threads if a DCP encode is interrupted. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/dcp_content_type.h" #include "lib/ratio.h" diff --git a/test/isdcf_name_test.cc b/test/isdcf_name_test.cc index bb47fa9c0..cc224aab7 100644 --- a/test/isdcf_name_test.cc +++ b/test/isdcf_name_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/isdcf_name_test.cc + * @brief Test creation of ISDCF names. + * @ingroup specific + */ + #include <boost/test/unit_test.hpp> #include "lib/film.h" #include "lib/ratio.h" diff --git a/test/j2k_bandwidth_test.cc b/test/j2k_bandwidth_test.cc index ed8f5d9c8..a941b4ae6 100644 --- a/test/j2k_bandwidth_test.cc +++ b/test/j2k_bandwidth_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/j2k_bandwidth_test.cc + * @brief Test whether we output whatever J2K bandwidth is requested. + * @ingroup specific + */ + #include "test.h" #include "lib/dcp_content_type.h" #include "lib/film.h" diff --git a/test/recover_test.cc b/test/recover_test.cc index 93288c300..95e45e08b 100644 --- a/test/recover_test.cc +++ b/test/recover_test.cc @@ -20,6 +20,7 @@ /** @file test/recover_test.cc * @brief Test recovery of a DCP transcode after a crash. + * @ingroup specific */ #include "test.h" diff --git a/test/rect_test.cc b/test/rect_test.cc index 90d6f096f..1e3730148 100644 --- a/test/rect_test.cc +++ b/test/rect_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/rect_test.cc + * @brief Test Rect class. + * @ingroup selfcontained + */ + #include "lib/rect.h" #include <boost/test/unit_test.hpp> #include <iostream> diff --git a/test/reels_test.cc b/test/reels_test.cc index 1951d5374..a9ed07e73 100644 --- a/test/reels_test.cc +++ b/test/reels_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/reels_test.cc + * @brief Check manipulation of reels in various ways. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/ratio.h" #include "lib/ffmpeg_content.h" diff --git a/test/render_subtitles_test.cc b/test/render_subtitles_test.cc index 79c0e782b..4276a2b01 100644 --- a/test/render_subtitles_test.cc +++ b/test/render_subtitles_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/render_subtitles_test.cc + * @brief Check markup of subtitles for rendering. + * @ingroup specific + */ + #include "lib/render_subtitles.h" #include <dcp/subtitle_string.h> #include <boost/test/unit_test.hpp> diff --git a/test/repeat_frame_test.cc b/test/repeat_frame_test.cc index 7eac4e1a8..3ca9a738a 100644 --- a/test/repeat_frame_test.cc +++ b/test/repeat_frame_test.cc @@ -21,6 +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 * * @see test/skip_frame_test.cc */ diff --git a/test/required_disk_space_test.cc b/test/required_disk_space_test.cc index a34604dd4..bcb53bdaf 100644 --- a/test/required_disk_space_test.cc +++ b/test/required_disk_space_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/required_disk_space_test.cc + * @brief Check Film::required_disk_space + * @ingroup specific + */ + #include "lib/content_factory.h" #include "lib/film.h" #include "lib/dcp_content.h" diff --git a/test/scaling_test.cc b/test/scaling_test.cc index 5ac5c7525..13276977d 100644 --- a/test/scaling_test.cc +++ b/test/scaling_test.cc @@ -20,6 +20,7 @@ /** @file test/scaling_test.cc * @brief Test scaling and black-padding of images from a still-image source. + * @ingroup specific */ #include <boost/test/unit_test.hpp> diff --git a/test/silence_padding_test.cc b/test/silence_padding_test.cc index 1eb502007..6c7d0b5ff 100644 --- a/test/silence_padding_test.cc +++ b/test/silence_padding_test.cc @@ -20,6 +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 */ #include "lib/ffmpeg_content.h" diff --git a/test/skip_frame_test.cc b/test/skip_frame_test.cc index 535efacdf..97aadb2f7 100644 --- a/test/skip_frame_test.cc +++ b/test/skip_frame_test.cc @@ -21,6 +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 * * @see test/repeat_frame_test.cc */ diff --git a/test/srt_subtitle_test.cc b/test/srt_subtitle_test.cc index ecf2130ec..9b9e6b5c6 100644 --- a/test/srt_subtitle_test.cc +++ b/test/srt_subtitle_test.cc @@ -20,6 +20,7 @@ /** @file test/srt_subtitle_test.cc * @brief Test writing DCPs with subtitles from .srt. + * @ingroup specific */ #include "lib/film.h" diff --git a/test/ssa_subtitle_test.cc b/test/ssa_subtitle_test.cc index ed8c20424..63a90b448 100644 --- a/test/ssa_subtitle_test.cc +++ b/test/ssa_subtitle_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/ssa_subtitle_test.cc + * @brief Test use of SSA subtitle files. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/text_subtitle_content.h" #include "lib/dcp_content_type.h" diff --git a/test/threed_test.cc b/test/threed_test.cc index 4ffbdf0e6..30de1f1a2 100644 --- a/test/threed_test.cc +++ b/test/threed_test.cc @@ -19,7 +19,8 @@ */ /** @file test/threed_test.cc - * @brief Create a 3D DCP (without comparing the result to anything). + * @brief Create some 3D DCPs (without comparing the results to anything). + * @ingroup completedcp */ #include <boost/test/unit_test.hpp> diff --git a/test/time_calculation_test.cc b/test/time_calculation_test.cc index 391d30dbd..4524242d9 100644 --- a/test/time_calculation_test.cc +++ b/test/time_calculation_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/time_calculation_test.cc + * @brief Test calculation of timings when frame rates change. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/ffmpeg_content.h" #include "lib/video_content.h" diff --git a/test/torture_test.cc b/test/torture_test.cc index b941a5ade..958e7167d 100644 --- a/test/torture_test.cc +++ b/test/torture_test.cc @@ -19,7 +19,8 @@ */ /** @file test/torture_test.cc - * @brief Entire projects that are programmatically created and checked. + * @brief Tricky arrangements of content whose resulting DCPs are checked programmatically. + * @ingroup completedcp */ #include "lib/audio_content.h" diff --git a/test/update_checker_test.cc b/test/update_checker_test.cc index 621b0572e..772665772 100644 --- a/test/update_checker_test.cc +++ b/test/update_checker_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/update_checker_test.cc + * @brief Check UpdateChecker::version_less_than + * @ingroup specific + */ + #include <boost/test/unit_test.hpp> #include "lib/update_checker.h" diff --git a/test/upmixer_a_test.cc b/test/upmixer_a_test.cc index 99c897252..2dccedacb 100644 --- a/test/upmixer_a_test.cc +++ b/test/upmixer_a_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/upmixer_a_test.cc + * @brief Check the Upmixer A against some reference sound files. + * @ingroup specific + */ + #include <boost/test/unit_test.hpp> #include <sndfile.h> #include "lib/film.h" diff --git a/test/vf_kdm_test.cc b/test/vf_kdm_test.cc index c7b0669c9..981ed43d4 100644 --- a/test/vf_kdm_test.cc +++ b/test/vf_kdm_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/vf_kdm_test.cc + * @brief Test encrypted VF creation and import + * @ingroup specific + */ + #include "test.h" #include "lib/film.h" #include "lib/dcp_subtitle_content.h" diff --git a/test/vf_test.cc b/test/vf_test.cc index 80d167ee2..ac8256be3 100644 --- a/test/vf_test.cc +++ b/test/vf_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/vf_Test.cc + * @brief Various VF-related tests. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/dcp_content.h" #include "lib/ffmpeg_content.h" diff --git a/test/video_content_scale_test.cc b/test/video_content_scale_test.cc index e7fddd720..202243dd8 100644 --- a/test/video_content_scale_test.cc +++ b/test/video_content_scale_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/video_content_scale_test.cc + * @brief Test VideoContentScale + * @ingroup selfcontained + */ + #include "lib/ffmpeg_content.h" #include "lib/ratio.h" #include "lib/video_content.h" diff --git a/test/video_mxf_content_test.cc b/test/video_mxf_content_test.cc index bdd35713c..9104702b6 100644 --- a/test/video_mxf_content_test.cc +++ b/test/video_mxf_content_test.cc @@ -18,6 +18,11 @@ */ +/** @file test/video_mxf_content_test.cc + * @brief Test use of Video MXF content. + * @ingroup specific + */ + #include "lib/film.h" #include "lib/video_mxf_content.h" #include "lib/content_factory.h" |
