add missing regression tests in last commit
[divverent/netradiant.git] / README.doxygen
1  Documentation for generating doxygen documentation
2 ---------------------------------------------------------
3
4 1. Options for gendox
5 More up-to-date command line options are available via
6 the command ./gendox --help
7
8 usage: "sh gendox [ <target(s)> ] [ -o <output_dir> ]"
9     or "./gendox [ <target(s)> ] [ -o <output_dir> ]"
10
11 <target(s)> 
12   The directory, or directories to generate the 
13   documentation from.
14
15 -o
16   Specifies the output directory <output_dir> which
17   should follow the -o switch
18   
19 -q --quiet
20   Stops the script from outputing status information,
21   other than errors.
22   
23 -k --kill
24   Kills other running doxygen pids.
25
26 eg: ./gendox include/ -o ../Documentation
27
28 * This will produce documentation for the include files,
29 and output to the directory specified one level above the
30 current directory.
31
32 The target can be the current directory "./" in which case
33 doxygen will generate documentation for all subdirectories
34 of the current directory recursively.
35
36 The default output directory is currently ...
37 > ../GtkRadiant-doxygen
38
39 * If the script is called without any target directories
40 it will generate documentation for the core of radiant...
41 include/ libs/ radiant/ and plugins/
42
43 If there are specific options that you'd like to customise,
44 the DoxyConfig file is used to generate the file from which
45 doxygen gets its settings from. So any changes that need
46 to be made should be made to this file.
47
48
49 Gef :]
50 (gefdavis@dingoblue.net.au)
51 ---------------------------------------------------------