Added a lot of Doxygen documentation
[u/mrichter/AliRoot.git] / FMD / Doxyfile
CommitLineData
9f662337 1# Doxyfile 1.4.6
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME = "ALICE FMD Off-line"
7PROJECT_NUMBER = 0.1
8OUTPUT_DIRECTORY =
9CREATE_SUBDIRS = NO
10OUTPUT_LANGUAGE = English
11USE_WINDOWS_ENCODING = NO
12BRIEF_MEMBER_DESC = NO
13REPEAT_BRIEF = YES
14ABBREVIATE_BRIEF = "The $name class" \
15 "The $name widget" \
16 "The $name file" \
17 is \
18 provides \
19 specifies \
20 contains \
21 represents \
22 a \
23 an \
24 the
25ALWAYS_DETAILED_SEC = YES
26INLINE_INHERITED_MEMB = NO
27FULL_PATH_NAMES = YES
28STRIP_FROM_PATH = /home/hehi/cholm/work/alice/aliroot/FMD/
29STRIP_FROM_INC_PATH =
30SHORT_NAMES = NO
31JAVADOC_AUTOBRIEF = NO
32MULTILINE_CPP_IS_BRIEF = NO
33DETAILS_AT_TOP = YES
34INHERIT_DOCS = YES
35SEPARATE_MEMBER_PAGES = NO
36TAB_SIZE = 8
37ALIASES =
38OPTIMIZE_OUTPUT_FOR_C = NO
39OPTIMIZE_OUTPUT_JAVA = NO
40BUILTIN_STL_SUPPORT = NO
41DISTRIBUTE_GROUP_DOC = NO
42SUBGROUPING = YES
43#---------------------------------------------------------------------------
44# Build related configuration options
45#---------------------------------------------------------------------------
46EXTRACT_ALL = YES
47EXTRACT_PRIVATE = YES
48EXTRACT_STATIC = YES
49EXTRACT_LOCAL_CLASSES = YES
50EXTRACT_LOCAL_METHODS = NO
51HIDE_UNDOC_MEMBERS = NO
52HIDE_UNDOC_CLASSES = NO
53HIDE_FRIEND_COMPOUNDS = NO
54HIDE_IN_BODY_DOCS = NO
55INTERNAL_DOCS = NO
56CASE_SENSE_NAMES = YES
57HIDE_SCOPE_NAMES = NO
58SHOW_INCLUDE_FILES = YES
59INLINE_INFO = YES
60SORT_MEMBER_DOCS = YES
61SORT_BRIEF_DOCS = NO
62SORT_BY_SCOPE_NAME = NO
63GENERATE_TODOLIST = YES
64GENERATE_TESTLIST = YES
65GENERATE_BUGLIST = YES
66GENERATE_DEPRECATEDLIST= YES
67ENABLED_SECTIONS =
68MAX_INITIALIZER_LINES = 30
69SHOW_USED_FILES = YES
70SHOW_DIRECTORIES = NO
71FILE_VERSION_FILTER =
72#---------------------------------------------------------------------------
73# configuration options related to warning and progress messages
74#---------------------------------------------------------------------------
75QUIET = YES
76WARNINGS = YES
77WARN_IF_UNDOCUMENTED = YES
78WARN_IF_DOC_ERROR = YES
79WARN_NO_PARAMDOC = YES
80WARN_FORMAT = "$file:$line: $text"
81WARN_LOGFILE =
82#---------------------------------------------------------------------------
83# configuration options related to the input files
84#---------------------------------------------------------------------------
85INPUT = /home/hehi/cholm/work/alice/aliroot/FMD
86FILE_PATTERNS = *.h
87RECURSIVE = NO
88EXCLUDE =
89EXCLUDE_SYMLINKS = NO
90EXCLUDE_PATTERNS =
91EXAMPLE_PATH = /home/hehi/cholm/work/alice/aliroot/FMD/scripts/
92EXAMPLE_PATTERNS = *.C
93EXAMPLE_RECURSIVE = NO
94IMAGE_PATH =
95INPUT_FILTER =
96FILTER_PATTERNS =
97FILTER_SOURCE_FILES = NO
98#---------------------------------------------------------------------------
99# configuration options related to source browsing
100#---------------------------------------------------------------------------
101SOURCE_BROWSER = NO
102INLINE_SOURCES = NO
103STRIP_CODE_COMMENTS = YES
104REFERENCED_BY_RELATION = NO
105REFERENCES_RELATION = NO
106USE_HTAGS = NO
107VERBATIM_HEADERS = NO
108#---------------------------------------------------------------------------
109# configuration options related to the alphabetical class index
110#---------------------------------------------------------------------------
111ALPHABETICAL_INDEX = YES
112COLS_IN_ALPHA_INDEX = 5
113IGNORE_PREFIX =
114#---------------------------------------------------------------------------
115# configuration options related to the HTML output
116#---------------------------------------------------------------------------
117GENERATE_HTML = YES
118HTML_OUTPUT = html
119HTML_FILE_EXTENSION = .html
120HTML_HEADER =
121HTML_FOOTER =
122HTML_STYLESHEET =
123HTML_ALIGN_MEMBERS = YES
124GENERATE_HTMLHELP = NO
125CHM_FILE =
126HHC_LOCATION =
127GENERATE_CHI = NO
128BINARY_TOC = NO
129TOC_EXPAND = NO
130DISABLE_INDEX = NO
131ENUM_VALUES_PER_LINE = 4
132GENERATE_TREEVIEW = NO
133TREEVIEW_WIDTH = 250
134#---------------------------------------------------------------------------
135# configuration options related to the LaTeX output
136#---------------------------------------------------------------------------
137GENERATE_LATEX = NO
138LATEX_OUTPUT = latex
139LATEX_CMD_NAME = latex
140MAKEINDEX_CMD_NAME = makeindex
141COMPACT_LATEX = NO
142PAPER_TYPE = a4wide
143EXTRA_PACKAGES =
144LATEX_HEADER =
145PDF_HYPERLINKS = NO
146USE_PDFLATEX = NO
147LATEX_BATCHMODE = NO
148LATEX_HIDE_INDICES = NO
149#---------------------------------------------------------------------------
150# configuration options related to the RTF output
151#---------------------------------------------------------------------------
152GENERATE_RTF = NO
153RTF_OUTPUT = rtf
154COMPACT_RTF = NO
155RTF_HYPERLINKS = NO
156RTF_STYLESHEET_FILE =
157RTF_EXTENSIONS_FILE =
158#---------------------------------------------------------------------------
159# configuration options related to the man page output
160#---------------------------------------------------------------------------
161GENERATE_MAN = NO
162MAN_OUTPUT = man
163MAN_EXTENSION = .3
164MAN_LINKS = NO
165#---------------------------------------------------------------------------
166# configuration options related to the XML output
167#---------------------------------------------------------------------------
168GENERATE_XML = NO
169XML_OUTPUT = xml
170XML_SCHEMA =
171XML_DTD =
172XML_PROGRAMLISTING = YES
173#---------------------------------------------------------------------------
174# configuration options for the AutoGen Definitions output
175#---------------------------------------------------------------------------
176GENERATE_AUTOGEN_DEF = NO
177#---------------------------------------------------------------------------
178# configuration options related to the Perl module output
179#---------------------------------------------------------------------------
180GENERATE_PERLMOD = NO
181PERLMOD_LATEX = NO
182PERLMOD_PRETTY = YES
183PERLMOD_MAKEVAR_PREFIX =
184#---------------------------------------------------------------------------
185# Configuration options related to the preprocessor
186#---------------------------------------------------------------------------
187ENABLE_PREPROCESSING = YES
188MACRO_EXPANSION = YES
189EXPAND_ONLY_PREDEF = NO
190SEARCH_INCLUDES = YES
191INCLUDE_PATH =
192INCLUDE_FILE_PATTERNS =
193PREDEFINED =
194EXPAND_AS_DEFINED =
195SKIP_FUNCTION_MACROS = YES
196#---------------------------------------------------------------------------
197# Configuration::additions related to external references
198#---------------------------------------------------------------------------
199TAGFILES =
200GENERATE_TAGFILE =
201ALLEXTERNALS = NO
202EXTERNAL_GROUPS = YES
203PERL_PATH = /usr/bin/perl
204#---------------------------------------------------------------------------
205# Configuration options related to the dot tool
206#---------------------------------------------------------------------------
207CLASS_DIAGRAMS = YES
208HIDE_UNDOC_RELATIONS = YES
209HAVE_DOT = YES
210CLASS_GRAPH = YES
211COLLABORATION_GRAPH = YES
212GROUP_GRAPHS = YES
213UML_LOOK = YES
214TEMPLATE_RELATIONS = NO
215INCLUDE_GRAPH = YES
216INCLUDED_BY_GRAPH = YES
217CALL_GRAPH = NO
218GRAPHICAL_HIERARCHY = YES
219DIRECTORY_GRAPH = YES
220DOT_IMAGE_FORMAT = png
221DOT_PATH =
222DOTFILE_DIRS =
223MAX_DOT_GRAPH_WIDTH = 1024
224MAX_DOT_GRAPH_HEIGHT = 1024
225MAX_DOT_GRAPH_DEPTH = 1000
226DOT_TRANSPARENT = NO
227DOT_MULTI_TARGETS = YES
228GENERATE_LEGEND = YES
229DOT_CLEANUP = YES
230#---------------------------------------------------------------------------
231# Configuration::additions related to the search engine
232#---------------------------------------------------------------------------
233SEARCHENGINE = NO