Continue to remove $Id$ from top of file
[metze/wireshark/wip.git] / doxygen.cfg.in
1 # @configure_input@
2 @INCLUDE = doxygen_global.cfg
3
4 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
5 # by quotes) that should identify the project.
6
7 PROJECT_NAME           = "Wireshark Core"
8
9 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
10 # This could be handy for archiving the generated documentation or 
11 # if some version control system is used.
12
13 PROJECT_NUMBER         = @VERSION@
14
15 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
16 # base path where the generated documentation will be put. 
17 # If a relative path is entered, it will be relative to the location 
18 # where doxygen was started. If left blank the current directory will be used.
19
20 OUTPUT_DIRECTORY       = .
21
22 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
23 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
24 # put in front of it. If left blank `html' will be used as the default path.
25
26 HTML_OUTPUT            = wsar_html
27
28 # The INPUT tag can be used to specify the files and/or directories that contain 
29 # documented source files. You may enter file names like "myfile.cpp" or 
30 # directories like "/usr/src/myproject". Separate the files or directories 
31 # with spaces.
32
33 INPUT                  = .
34
35 # The TAGFILES option can be used to specify one or more tagfiles.
36 # Optionally an initial location of the external documentation
37 # can be added for each tagfile. The format of a tag file without
38 # this location is as follows:
39 #
40 # TAGFILES = file1 file2 ...
41 # Adding location for the tag files is done as follows:
42 #
43 # TAGFILES = file1=loc1 "file2 = loc2" ...
44 # where "loc1" and "loc2" can be relative or absolute paths or
45 # URLs. If a location is present for each tag, the installdox tool
46 # does not have to be run to correct the links.
47 # Note that each tag file must have a unique name
48 # (where the name does NOT include the path)
49 # If a tag file is not located in the directory in which doxygen
50 # is run, you must also specify the path to the tagfile here.
51
52 TAGFILES               = epan/doxygen-epan.tag=epan \
53                          ui/doxygen-ui.tag=ui
54
55 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
56 # a tag file that is based on the input files it reads.
57
58 GENERATE_TAGFILE       = doxygen-core.tag
59
60 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
61 # should be searched for input files as well. Possible values are YES and NO. 
62 # If left blank NO is used.
63
64 RECURSIVE              = NO
65
66 # The EXCLUDE tag can be used to specify files and/or directories that should 
67 # excluded from the INPUT source files. This way you can easily exclude a 
68 # subdirectory from a directory tree whose root is specified with the INPUT tag.
69
70 EXCLUDE                = 
71
72 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
73 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
74
75 EXCLUDE_SYMLINKS       = NO
76
77 # If the value of the INPUT tag contains directories, you can use the 
78 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
79 # certain files from those directories.
80
81 EXCLUDE_PATTERNS       = 
82
83 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
84 # be used to specify the file name of the resulting .chm file. You 
85 # can add a path in front of the file if the result should not be 
86 # written to the html output directory.
87
88 CHM_FILE               = wireshark-gtk.chm