@@ -44,7 +44,23 @@ file(DOWNLOAD
4444 SHOW_PROGRESS
4545)
4646
47- ## Wrapper that sets many default arguments for documentation illustration tests
47+ #[==[ .md
48+ # Wrapper that sets many common arguments for documentation illustration tests
49+
50+ Usage:
51+
52+ ```
53+ f3d_doc_test(<NAME> [ARGS...])
54+ ```
55+ - `UI` Mark the test to require the presence of UI component and disable it otherwise
56+ - `BACKGROUND` The background is visible, otherwise it's transparent
57+ - `ROTATE` Rotate the camera to show the model from a different angle, otherwise it's front facing
58+ - `NAME` Provide the name of the test, mandatory and must be unique
59+ - `THRESHOLD` Provide the `--reference-threshold` to use instead of the default
60+ - `DATA` Data to open, support multiple input, also set test labels accordingly
61+ - `REF_IMAGE` Provide the reference image name, saved into `doc/user/images`
62+ - `ARGS` Supplement arguments to add to the f3d command line
63+ #]==]
4864function (f3d_test_doc )
4965 cmake_parse_arguments (F3D_TEST_DOC "UI;BACKGROUND;ROTATE" "NAME;DATA;REF_IMAGE;THRESHOLD" "ARGS" ${ARGN} )
5066
@@ -290,7 +306,7 @@ f3d_test_doc(NAME TestDocHDRICOC50 DATA DamagedHelmet.glb REF_IMAGE hdri_coc_50.
290306
291307## --light-intensity
292308f3d_test_doc (NAME TestDocLightIntensity1 DATA DamagedHelmet.glb REF_IMAGE light_intensity_1.png ROTATE )
293- f3d_test_doc (NAME TestDocLightIntensity05 DATA DamagedHelmet.glb REF_IMAGE light_intensity_0.5. png ROTATE ARGS --light-intensity=0.5 )
309+ f3d_test_doc (NAME TestDocLightIntensity2 DATA DamagedHelmet.glb REF_IMAGE light_intensity_2. png ROTATE ARGS --light-intensity=2 )
294310
295311## --scalar-coloring
296312f3d_test_doc (NAME TestDocScalarColoringOFF DATA dragon.vtu REF_IMAGE scalar_coloring_off.png ROTATE ARGS )
0 commit comments