documentation
[u/mrichter/AliRoot.git] / HLT / doc / doxygen.conf.in
CommitLineData
4c449bf7 1# $Id$
b521659f 2#
3
4#---------------------------------------------------------------------------
5# General configuration options
6#---------------------------------------------------------------------------
7PROJECT_NAME = "@PACKAGE_NAME@"
8PROJECT_NUMBER = @PACKAGE_VERSION@
9OUTPUT_DIRECTORY = .
10OUTPUT_LANGUAGE = English
11USE_WINDOWS_ENCODING = NO
12BRIEF_MEMBER_DESC = NO
13REPEAT_BRIEF = YES
14ALWAYS_DETAILED_SEC = YES
15INLINE_INHERITED_MEMB = NO
16FULL_PATH_NAMES = NO
17STRIP_FROM_PATH =
18SHORT_NAMES = NO
19JAVADOC_AUTOBRIEF = YES
20MULTILINE_CPP_IS_BRIEF = NO
21DETAILS_AT_TOP = YES
22INHERIT_DOCS = YES
23DISTRIBUTE_GROUP_DOC = NO
24TAB_SIZE = 8
25GENERATE_TESTLIST = YES
26GENERATE_BUGLIST = YES
27ALIASES =
28OPTIMIZE_OUTPUT_FOR_C = YES
29OPTIMIZE_OUTPUT_JAVA = NO
30SUBGROUPING = YES
31
32#---------------------------------------------------------------------------
33# Build related configuration options
34#---------------------------------------------------------------------------
35EXTRACT_ALL = YES
36EXTRACT_PRIVATE = YES
37EXTRACT_STATIC = YES
38EXTRACT_LOCAL_CLASSES = YES
39HIDE_UNDOC_MEMBERS = NO
40HIDE_UNDOC_CLASSES = NO
41HIDE_FRIEND_COMPOUNDS = NO
42HIDE_IN_BODY_DOCS = YES
43INTERNAL_DOCS = NO
44CASE_SENSE_NAMES = YES
45HIDE_SCOPE_NAMES = NO
46SHOW_INCLUDE_FILES = YES
47INLINE_INFO = YES
48SORT_MEMBER_DOCS = YES
49GENERATE_TODOLIST = YES
50GENERATE_DEPRECATEDLIST= YES
51ENABLED_SECTIONS =
52MAX_INITIALIZER_LINES = 30
53SHOW_USED_FILES = YES
54#---------------------------------------------------------------------------
55# configuration options related to warning and progress messages
56#---------------------------------------------------------------------------
57QUIET = YES
58WARNINGS = YES
59WARN_IF_UNDOCUMENTED = YES
ccef02e8 60WARN_IF_DOC_ERROR = NO
b521659f 61WARN_FORMAT = "$file:$line: $text"
62WARN_LOGFILE =
63#---------------------------------------------------------------------------
64# configuration options related to the input files
65#---------------------------------------------------------------------------
66INPUT = @top_srcdir@/doc \
9be2600f 67 readme.c \
7b969ef7 68 sample_readme.c \
ccef02e8 69 module_group.c \
b22e91eb 70 @top_srcdir@/BASE \
90ebac25 71 @top_srcdir@/SampleLib \
2ff24e4c 72 @top_srcdir@/rec \
73 @top_srcdir@/exa \
9d4cf2ab 74 @top_srcdir@/shuttle \
ccef02e8 75 @top_srcdir@/sim
90ebac25 76
10bd167f 77FILE_PATTERNS = *.h *.c *.cpp *.hpp *.cxx *.C
b521659f 78RECURSIVE = YES
f275e0cf 79EXCLUDE = @top_srcdir@/TPCLib/gui
2a083ac4 80
b521659f 81EXCLUDE_SYMLINKS = NO
82EXCLUDE_PATTERNS =
83EXAMPLE_PATH =
84EXAMPLE_PATTERNS =
85EXAMPLE_RECURSIVE = NO
b22e91eb 86IMAGE_PATH = @srcdir@/pics
b521659f 87INPUT_FILTER =
88FILTER_SOURCE_FILES = NO
89#---------------------------------------------------------------------------
90# configuration options related to source browsing
91#---------------------------------------------------------------------------
90ebac25 92SOURCE_BROWSER = YES
b521659f 93INLINE_SOURCES = NO
94STRIP_CODE_COMMENTS = YES
95REFERENCED_BY_RELATION = YES
96REFERENCES_RELATION = YES
97VERBATIM_HEADERS = NO
98#---------------------------------------------------------------------------
99# configuration options related to the alphabetical class index
100#---------------------------------------------------------------------------
101ALPHABETICAL_INDEX = YES
102COLS_IN_ALPHA_INDEX = 5
103IGNORE_PREFIX =
104#---------------------------------------------------------------------------
105# configuration options related to the HTML output
106#---------------------------------------------------------------------------
107GENERATE_HTML = YES
108HTML_OUTPUT = html
109HTML_FILE_EXTENSION = .html
110HTML_HEADER =
111HTML_FOOTER =
112HTML_STYLESHEET =
113HTML_ALIGN_MEMBERS = YES
114GENERATE_HTMLHELP = NO
115CHM_FILE =
116HHC_LOCATION =
117GENERATE_CHI = NO
118BINARY_TOC = NO
119TOC_EXPAND = NO
120DISABLE_INDEX = NO
121ENUM_VALUES_PER_LINE = 4
122GENERATE_TREEVIEW = NO
123TREEVIEW_WIDTH = 150
124#---------------------------------------------------------------------------
125# configuration options related to the LaTeX output
126#---------------------------------------------------------------------------
e824c10d 127GENERATE_LATEX = NO
b521659f 128LATEX_OUTPUT = latex
129LATEX_CMD_NAME = latex
130MAKEINDEX_CMD_NAME = makeindex
131COMPACT_LATEX = YES
132PAPER_TYPE = a4wide
133EXTRA_PACKAGES =
134LATEX_HEADER =
135PDF_HYPERLINKS = YES
136USE_PDFLATEX = YES
137LATEX_BATCHMODE = NO
b22e91eb 138LATEX_HIDE_INDICES = YES
b521659f 139#---------------------------------------------------------------------------
140# configuration options related to the RTF output
141#---------------------------------------------------------------------------
142GENERATE_RTF = NO
143RTF_OUTPUT = rtf
144COMPACT_RTF = NO
145RTF_HYPERLINKS = NO
146RTF_STYLESHEET_FILE =
147RTF_EXTENSIONS_FILE =
148#---------------------------------------------------------------------------
149# configuration options related to the man page output
150#---------------------------------------------------------------------------
151GENERATE_MAN = NO
152MAN_OUTPUT = man
153MAN_EXTENSION = .3
154MAN_LINKS = NO
155#---------------------------------------------------------------------------
156# configuration options related to the XML output
157#---------------------------------------------------------------------------
158GENERATE_XML = NO
159XML_OUTPUT = xml
160XML_SCHEMA =
161XML_DTD =
162#---------------------------------------------------------------------------
163# configuration options for the AutoGen Definitions output
164#---------------------------------------------------------------------------
165GENERATE_AUTOGEN_DEF = NO
166#---------------------------------------------------------------------------
167# configuration options related to the Perl module output
168#---------------------------------------------------------------------------
169GENERATE_PERLMOD = NO
170PERLMOD_LATEX = NO
171PERLMOD_PRETTY = YES
172PERLMOD_MAKEVAR_PREFIX =
173#---------------------------------------------------------------------------
174# Configuration options related to the preprocessor
175#---------------------------------------------------------------------------
176ENABLE_PREPROCESSING = YES
177MACRO_EXPANSION = YES
178EXPAND_ONLY_PREDEF = NO
179SEARCH_INCLUDES = YES
180INCLUDE_PATH =
181INCLUDE_FILE_PATTERNS =
182PREDEFINED = "DOXYGEN_INPUT"
183EXPAND_AS_DEFINED =
184SKIP_FUNCTION_MACROS = YES
185#---------------------------------------------------------------------------
186# Configuration::addtions related to external references
187#---------------------------------------------------------------------------
188TAGFILES =
189GENERATE_TAGFILE = @PACKAGE@.tags
190ALLEXTERNALS = NO
191EXTERNAL_GROUPS = YES
192PERL_PATH = @PERL@
193#---------------------------------------------------------------------------
194# Configuration options related to the dot tool
195#---------------------------------------------------------------------------
196CLASS_DIAGRAMS = YES
197HIDE_UNDOC_RELATIONS = NO
198HAVE_DOT = @HAVE_DOT@
199CLASS_GRAPH = YES
200COLLABORATION_GRAPH = YES
201UML_LOOK = YES
202TEMPLATE_RELATIONS = YES
203INCLUDE_GRAPH = YES
204INCLUDED_BY_GRAPH = YES
205CALL_GRAPH = YES
206GRAPHICAL_HIERARCHY = YES
207DOT_IMAGE_FORMAT = png
208DOT_PATH = @DOT_PATH@
209DOTFILE_DIRS =
210MAX_DOT_GRAPH_WIDTH = 640
211MAX_DOT_GRAPH_HEIGHT = 640
212MAX_DOT_GRAPH_DEPTH = 0
213GENERATE_LEGEND = YES
214DOT_CLEANUP = YES
215#---------------------------------------------------------------------------
216# Configuration::addtions related to the search engine
217#---------------------------------------------------------------------------
218SEARCHENGINE = NO