Name
Last commit
Last update
..
001 Loading commit data...
002 Loading commit data...
003 Loading commit data...
004 Loading commit data...
005 Loading commit data...
006 Loading commit data...
007 Loading commit data...
008 Loading commit data...
009 Loading commit data...
010 Loading commit data...
011 Loading commit data...
012 Loading commit data...
013 Loading commit data...
014 Loading commit data...
015 Loading commit data...
016 Loading commit data...
017 Loading commit data...
018 Loading commit data...
019 Loading commit data...
020 Loading commit data...
021 Loading commit data...
022 Loading commit data...
023 Loading commit data...
024 Loading commit data...
025 Loading commit data...
026 Loading commit data...
027 Loading commit data...
028 Loading commit data...
029 Loading commit data...
030 Loading commit data...
031 Loading commit data...
032 Loading commit data...
033 Loading commit data...
034 Loading commit data...
035 Loading commit data...
036 Loading commit data...
037 Loading commit data...
038 Loading commit data...
039 Loading commit data...
040 Loading commit data...
041 Loading commit data...
042 Loading commit data...
043 Loading commit data...
044 Loading commit data...
045 Loading commit data...
046 Loading commit data...
047 Loading commit data...
048 Loading commit data...
049 Loading commit data...
050 Loading commit data...
051 Loading commit data...
052 Loading commit data...
053 Loading commit data...
054 Loading commit data...
055 Loading commit data...
056 Loading commit data...
057 Loading commit data...
058 Loading commit data...
059 Loading commit data...
060 Loading commit data...
061 Loading commit data...
062 Loading commit data...
063 Loading commit data...
001_a.dox Loading commit data...
002_addindex.dox Loading commit data...
003_anchor.dox Loading commit data...
004_arg.dox Loading commit data...
005_attention.dox Loading commit data...
006_author.dox Loading commit data...
007_b.dox Loading commit data...
008_brief.c Loading commit data...
009_bug.cpp Loading commit data...
010_c.dox Loading commit data...
011_category.m Loading commit data...
012_cite.dox Loading commit data...
013_class.h Loading commit data...
014_code.dox Loading commit data...
015_cond.c Loading commit data...
016_copydoc.c Loading commit data...
017_copyright.dox Loading commit data...
018_def.c Loading commit data...
019_defgroup.c Loading commit data...
020_only.dox Loading commit data...
021_dontinclude.cpp Loading commit data...
022_dot.cpp Loading commit data...
023_e.dox Loading commit data...
024_if.dox Loading commit data...
025_example.cpp Loading commit data...
026_exception.cpp Loading commit data...
027_extends.c Loading commit data...
028_formula.c Loading commit data...
029_hideinit.c Loading commit data...
030_htmlinclude.dox Loading commit data...
031_image.dox Loading commit data...
032_include.cpp Loading commit data...
033_internal.dox Loading commit data...
034_internal.dox Loading commit data...
035_invariant.c Loading commit data...
036_link.c Loading commit data...
037_msc.cpp Loading commit data...
038_n.dox Loading commit data...
039_name.cpp Loading commit data...
040_namespace.cpp Loading commit data...
041_overload.cpp Loading commit data...
042_package.java Loading commit data...
043_page.dox Loading commit data...
044_section.h Loading commit data...
045_refitem.dox Loading commit data...
046_related.cpp Loading commit data...
047_return.cpp Loading commit data...
048_showinit.c Loading commit data...
049_snippet.cpp Loading commit data...
050_verbatim.dox Loading commit data...
051_escape.dox Loading commit data...
052_tilde.dox Loading commit data...
053_tilde.dox Loading commit data...
054_parblock.cpp Loading commit data...
055_markdown.md Loading commit data...
056_latexinclude.dox Loading commit data...
057_caller_graphs.tcl Loading commit data...
058_bracket_recursion.tcl Loading commit data...
059_command_catch.tcl Loading commit data...
060_command_switch.tcl Loading commit data...
061_bug_705503.tcl Loading commit data...
062_namespace_resolution.tcl Loading commit data...
063_bug_729092.tcl Loading commit data...
Doxyfile Loading commit data...
Makefile Loading commit data...
README Loading commit data...
_057_caller_graphs.tcl Loading commit data...
example_test.cpp Loading commit data...
runtests.pl Loading commit data...
sample.bib Loading commit data...
sample.html Loading commit data...
sample.png Loading commit data...
sample.tex Loading commit data...
snippet_test.cpp Loading commit data...
testsqlite3.py Loading commit data...
Doxygen regession 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.

The runtest.pl script responsible for running the tests takes a number of 
optional parameters:
-id n:        run test with number n only (the option may be specified 
              multiple times) default is to run all tests.
-updateref:   update the reference files. Should be used in combination 
              with -id to update the reference file(s) for the given test.
-all:         can be used in combination with -updateref to update the
              reference files for all tests.
-doxygen exe: run the specified doxygen executable.
-xmllint exe: run the specified xmllint executable.

The runtest.pl has the following dependenies on 3rd party tools:
- perl    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:
    perl runtest.pl

Example to run a test
    perl runtest.pl -id 10

Example to update the reference files for a test
    perl runtest.pl -updateref -id 10

There is also a Makefile, which can be used to run all tests by simply
invoking make.