doxygen/tests/upstream-test-suite
2019-03-06 18:39:53 +01:00
..
001 Add gating on tests 2019-03-06 18:39:53 +01:00
002 Add gating on tests 2019-03-06 18:39:53 +01:00
003 Add gating on tests 2019-03-06 18:39:53 +01:00
004 Add gating on tests 2019-03-06 18:39:53 +01:00
005 Add gating on tests 2019-03-06 18:39:53 +01:00
006 Add gating on tests 2019-03-06 18:39:53 +01:00
007 Add gating on tests 2019-03-06 18:39:53 +01:00
008 Add gating on tests 2019-03-06 18:39:53 +01:00
009 Add gating on tests 2019-03-06 18:39:53 +01:00
010 Add gating on tests 2019-03-06 18:39:53 +01:00
011 Add gating on tests 2019-03-06 18:39:53 +01:00
012 Add gating on tests 2019-03-06 18:39:53 +01:00
013 Add gating on tests 2019-03-06 18:39:53 +01:00
014 Add gating on tests 2019-03-06 18:39:53 +01:00
015 Add gating on tests 2019-03-06 18:39:53 +01:00
016 Add gating on tests 2019-03-06 18:39:53 +01:00
017 Add gating on tests 2019-03-06 18:39:53 +01:00
018 Add gating on tests 2019-03-06 18:39:53 +01:00
019 Add gating on tests 2019-03-06 18:39:53 +01:00
020 Add gating on tests 2019-03-06 18:39:53 +01:00
021 Add gating on tests 2019-03-06 18:39:53 +01:00
022 Add gating on tests 2019-03-06 18:39:53 +01:00
023 Add gating on tests 2019-03-06 18:39:53 +01:00
024 Add gating on tests 2019-03-06 18:39:53 +01:00
025 Add gating on tests 2019-03-06 18:39:53 +01:00
026 Add gating on tests 2019-03-06 18:39:53 +01:00
027 Add gating on tests 2019-03-06 18:39:53 +01:00
028 Add gating on tests 2019-03-06 18:39:53 +01:00
029 Add gating on tests 2019-03-06 18:39:53 +01:00
030 Add gating on tests 2019-03-06 18:39:53 +01:00
031 Add gating on tests 2019-03-06 18:39:53 +01:00
032 Add gating on tests 2019-03-06 18:39:53 +01:00
033 Add gating on tests 2019-03-06 18:39:53 +01:00
034 Add gating on tests 2019-03-06 18:39:53 +01:00
035 Add gating on tests 2019-03-06 18:39:53 +01:00
036 Add gating on tests 2019-03-06 18:39:53 +01:00
037 Add gating on tests 2019-03-06 18:39:53 +01:00
038 Add gating on tests 2019-03-06 18:39:53 +01:00
039 Add gating on tests 2019-03-06 18:39:53 +01:00
040 Add gating on tests 2019-03-06 18:39:53 +01:00
041 Add gating on tests 2019-03-06 18:39:53 +01:00
042 Add gating on tests 2019-03-06 18:39:53 +01:00
043 Add gating on tests 2019-03-06 18:39:53 +01:00
044 Add gating on tests 2019-03-06 18:39:53 +01:00
045 Add gating on tests 2019-03-06 18:39:53 +01:00
046 Add gating on tests 2019-03-06 18:39:53 +01:00
047 Add gating on tests 2019-03-06 18:39:53 +01:00
048 Add gating on tests 2019-03-06 18:39:53 +01:00
049 Add gating on tests 2019-03-06 18:39:53 +01:00
050 Add gating on tests 2019-03-06 18:39:53 +01:00
051 Add gating on tests 2019-03-06 18:39:53 +01:00
052 Add gating on tests 2019-03-06 18:39:53 +01:00
053 Add gating on tests 2019-03-06 18:39:53 +01:00
054 Add gating on tests 2019-03-06 18:39:53 +01:00
055 Add gating on tests 2019-03-06 18:39:53 +01:00
056 Add gating on tests 2019-03-06 18:39:53 +01:00
057 Add gating on tests 2019-03-06 18:39:53 +01:00
058 Add gating on tests 2019-03-06 18:39:53 +01:00
059 Add gating on tests 2019-03-06 18:39:53 +01:00
060 Add gating on tests 2019-03-06 18:39:53 +01:00
061 Add gating on tests 2019-03-06 18:39:53 +01:00
062 Add gating on tests 2019-03-06 18:39:53 +01:00
063 Add gating on tests 2019-03-06 18:39:53 +01:00
064 Add gating on tests 2019-03-06 18:39:53 +01:00
065 Add gating on tests 2019-03-06 18:39:53 +01:00
066 Add gating on tests 2019-03-06 18:39:53 +01:00
067 Add gating on tests 2019-03-06 18:39:53 +01:00
068 Add gating on tests 2019-03-06 18:39:53 +01:00
069 Add gating on tests 2019-03-06 18:39:53 +01:00
070 Add gating on tests 2019-03-06 18:39:53 +01:00
071 Add gating on tests 2019-03-06 18:39:53 +01:00
072 Add gating on tests 2019-03-06 18:39:53 +01:00
073 Add gating on tests 2019-03-06 18:39:53 +01:00
074 Add gating on tests 2019-03-06 18:39:53 +01:00
075 Add gating on tests 2019-03-06 18:39:53 +01:00
076 Add gating on tests 2019-03-06 18:39:53 +01:00
077 Add gating on tests 2019-03-06 18:39:53 +01:00
078 Add gating on tests 2019-03-06 18:39:53 +01:00
dtd Add gating on tests 2019-03-06 18:39:53 +01:00
_057_caller_graphs.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
001_a.dox Add gating on tests 2019-03-06 18:39:53 +01:00
002_addindex.dox Add gating on tests 2019-03-06 18:39:53 +01:00
003_anchor.dox Add gating on tests 2019-03-06 18:39:53 +01:00
004_arg.dox Add gating on tests 2019-03-06 18:39:53 +01:00
005_attention.dox Add gating on tests 2019-03-06 18:39:53 +01:00
006_author.dox Add gating on tests 2019-03-06 18:39:53 +01:00
007_b.dox Add gating on tests 2019-03-06 18:39:53 +01:00
008_brief.c Add gating on tests 2019-03-06 18:39:53 +01:00
009_bug.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
010_c.dox Add gating on tests 2019-03-06 18:39:53 +01:00
011_category.m Add gating on tests 2019-03-06 18:39:53 +01:00
012_cite.dox Add gating on tests 2019-03-06 18:39:53 +01:00
013_class.h Add gating on tests 2019-03-06 18:39:53 +01:00
014_code.dox Add gating on tests 2019-03-06 18:39:53 +01:00
015_cond.c Add gating on tests 2019-03-06 18:39:53 +01:00
016_copydoc.c Add gating on tests 2019-03-06 18:39:53 +01:00
017_copyright.dox Add gating on tests 2019-03-06 18:39:53 +01:00
018_def.c Add gating on tests 2019-03-06 18:39:53 +01:00
019_defgroup.c Add gating on tests 2019-03-06 18:39:53 +01:00
020_only.dox Add gating on tests 2019-03-06 18:39:53 +01:00
021_dontinclude.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
022_dot.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
023_e.dox Add gating on tests 2019-03-06 18:39:53 +01:00
024_if.dox Add gating on tests 2019-03-06 18:39:53 +01:00
025_example.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
026_exception.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
027_extends.c Add gating on tests 2019-03-06 18:39:53 +01:00
028_formula.c Add gating on tests 2019-03-06 18:39:53 +01:00
029_hideinit.c Add gating on tests 2019-03-06 18:39:53 +01:00
030_htmlinclude.dox Add gating on tests 2019-03-06 18:39:53 +01:00
031_image.dox Add gating on tests 2019-03-06 18:39:53 +01:00
032_include.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
033_internal.dox Add gating on tests 2019-03-06 18:39:53 +01:00
034_internal.dox Add gating on tests 2019-03-06 18:39:53 +01:00
035_invariant.c Add gating on tests 2019-03-06 18:39:53 +01:00
036_link.c Add gating on tests 2019-03-06 18:39:53 +01:00
037_msc.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
038_n.dox Add gating on tests 2019-03-06 18:39:53 +01:00
039_name.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
040_namespace.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
041_overload.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
042_package.java Add gating on tests 2019-03-06 18:39:53 +01:00
043_page.dox Add gating on tests 2019-03-06 18:39:53 +01:00
044_section.h Add gating on tests 2019-03-06 18:39:53 +01:00
045_refitem.dox Add gating on tests 2019-03-06 18:39:53 +01:00
046_related.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
047_return.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
048_showinit.c Add gating on tests 2019-03-06 18:39:53 +01:00
049_snippet.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
050_verbatim.dox Add gating on tests 2019-03-06 18:39:53 +01:00
051_escape.dox Add gating on tests 2019-03-06 18:39:53 +01:00
052_tilde.dox Add gating on tests 2019-03-06 18:39:53 +01:00
053_tilde.dox Add gating on tests 2019-03-06 18:39:53 +01:00
054_parblock.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
055_markdown.md Add gating on tests 2019-03-06 18:39:53 +01:00
056_latexinclude.dox Add gating on tests 2019-03-06 18:39:53 +01:00
057_caller_graphs.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
058_bracket_recursion.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
059_command_catch.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
060_command_switch.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
061_bug_705503.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
062_namespace_resolution.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
063_bug_729092.tcl Add gating on tests 2019-03-06 18:39:53 +01:00
064_castoperator.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
065_tilde.dox Add gating on tests 2019-03-06 18:39:53 +01:00
066_property_initializer.cs Add gating on tests 2019-03-06 18:39:53 +01:00
067_link_varargs.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
068_ref_varargs.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
069_link_variadic_template.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
070_ref_variadic_template.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
071_enum_in_anon_ns.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
072_using.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
073_typed_enum.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
074_ref.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
075_argmatch.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
076_emojis.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
077_no_xml_namespace_members_in_file_scope.h Add gating on tests 2019-03-06 18:39:53 +01:00
078_xml_namespace_members_in_file_scope.h Add gating on tests 2019-03-06 18:39:53 +01:00
Doxyfile Add gating on tests 2019-03-06 18:39:53 +01:00
example_test.cpp Add gating on tests 2019-03-06 18:39:53 +01:00
Makefile Add gating on tests 2019-03-06 18:39:53 +01:00
PURPOSE Add gating on tests 2019-03-06 18:39:53 +01:00
README.txt Add gating on tests 2019-03-06 18:39:53 +01:00
runtest.sh Add gating on tests 2019-03-06 18:39:53 +01:00
runtests.py Add gating on tests 2019-03-06 18:39:53 +01:00
sample.bib Add gating on tests 2019-03-06 18:39:53 +01:00
sample.html Add gating on tests 2019-03-06 18:39:53 +01:00
sample.png Add gating on tests 2019-03-06 18:39:53 +01:00
sample.tex Add gating on tests 2019-03-06 18:39:53 +01:00
snippet_test.cpp Add gating on tests 2019-03-06 18:39:53 +01:00

Doxygen regression test suite
============================

This directory contains a set of regression tests. Each test consists of a
file starting with a 3 digit number and a corresponding directory whose name
has the same 3 digit number. The directory contains one or more reference
files that are compared against the XML output produced by doxygen. If the
result is the same, there is no regression and the test passes. If there is a
difference the test fails and the difference (in diff -u format) will be shown.
It is also possible to see whether or not the test can be built to a xhtml set
of files (and tested against a DTD), it is also possible to create a pdf file
for each test to see if the LaTeX / pdf generation is possible.

The runtest.py script responsible for running the tests takes a number of
optional parameters:
  --updateref           update the reference data for a test
  --doxygen [DOXYGEN]   path/name of the doxygen executable
  --xmllint [XMLLINT]   path/name of the xmllint executable
  --id IDS [IDS ...]    id of the test to perform
  --start_id START_ID   run tests starting with number n
  --end_id END_ID       run tests ending with number n
  --all                 perform all tests
  --inputdir [INPUTDIR]
                        input directory containing the tests
  --outputdir [OUTPUTDIR]
                        output directory to write the doxygen output to
  --noredir             disable redirection of doxygen warnings
  --xml                 create xml output and check
  --rtf                 create rtf output
  --docbook             create docbook output and check with xmllint
  --xhtml               create xhtml output and check with xmllint
  --pdf                 create LaTeX output and create pdf from it
  --subdirs             use the configuration parameter CREATE_SUBDIRS=YES
  --keep                keep result directories
  --cfg CFGS [CFGS ...] run test with extra doxygen configuration settings
                        (the option may be specified multiple times
In case neither --xml, --pdf, --rtf, --docbook or --xhtml is used the default is set to --xml.

The runtest.pl has the following dependencies on 3rd party tools:
- python  to run the script
- xmllint to normalize the XML output
- diff    to show the differences in case a test fails

Each test file can have a number of special comment lines that are extracted by
the runtest.pl script and take the form:
// <identifier>: 'argument'
Where <identifier> can be one of:
- objective: 'argument' provides the objective for the test (i.e. its purpose)
- check:     'argument' names a file that is generated by doxygen, which should
             be compared against the reference.
- config:    'argument' is a line that is added to the default Doxyfile used to
             run doxygen on the test file.

Example to run all tests:
    python runtest.py

Example to run a test
    python runtest.py -id 10

Example to update the reference files for a test
    python runtest.py -updateref -id 10

There is also a CMakeLists.txt, which can be used from the build directory
to run all tests by simply invoking 'make tests', to use the specific options use
the flag TEST_FLAGS with make
  e.g. make tests TEST_FLAGS="--id=5 --id=10 --pdf --xhtml"