]> git.uio.no Git - u/mrichter/AliRoot.git/blame - HLT/doc/doxygen.conf.in
Porting HLT doxygen documentation to cmake
[u/mrichter/AliRoot.git] / HLT / doc / doxygen.conf.in
CommitLineData
4c449bf7 1# $Id$
b521659f 2#
3
4#---------------------------------------------------------------------------
28c214e9 5# Project related configuration options
b521659f 6#---------------------------------------------------------------------------
28c214e9 7# This tag specifies the encoding used for all characters in the config file
8# that follow. The default is UTF-8 which is also the encoding used for all
9# text before the first occurrence of this tag. Doxygen uses libiconv (or the
10# iconv built into libc) for the transcoding. See
11# http://www.gnu.org/software/libiconv for the list of possible encodings.
12
13DOXYFILE_ENCODING = UTF-8
ebf7a8e8
TB
14PROJECT_NAME = "ALICE HLT"
15PROJECT_NUMBER = @ALIROOT_BRANCH@
16OUTPUT_DIRECTORY = @HLT_doxy_output_root@
28c214e9 17CREATE_SUBDIRS = NO
b521659f 18OUTPUT_LANGUAGE = English
b521659f 19BRIEF_MEMBER_DESC = NO
20REPEAT_BRIEF = YES
28c214e9 21ABBREVIATE_BRIEF =
b521659f 22ALWAYS_DETAILED_SEC = YES
23INLINE_INHERITED_MEMB = NO
24FULL_PATH_NAMES = NO
25STRIP_FROM_PATH =
28c214e9 26STRIP_FROM_INC_PATH =
b521659f 27SHORT_NAMES = NO
28JAVADOC_AUTOBRIEF = YES
28c214e9 29QT_AUTOBRIEF = NO
b521659f 30MULTILINE_CPP_IS_BRIEF = NO
b521659f 31INHERIT_DOCS = YES
28c214e9 32SEPARATE_MEMBER_PAGES = NO
b521659f 33TAB_SIZE = 8
34GENERATE_TESTLIST = YES
35GENERATE_BUGLIST = YES
36ALIASES =
37OPTIMIZE_OUTPUT_FOR_C = YES
38OPTIMIZE_OUTPUT_JAVA = NO
28c214e9 39OPTIMIZE_FOR_FORTRAN = NO
40OPTIMIZE_OUTPUT_VHDL = NO
41BUILTIN_STL_SUPPORT = NO
42CPP_CLI_SUPPORT = NO
43SIP_SUPPORT = NO
44IDL_PROPERTY_SUPPORT = YES
45DISTRIBUTE_GROUP_DOC = NO
b521659f 46SUBGROUPING = YES
28c214e9 47TYPEDEF_HIDES_STRUCT = NO
48SYMBOL_CACHE_SIZE = 0
b521659f 49
50#---------------------------------------------------------------------------
51# Build related configuration options
52#---------------------------------------------------------------------------
53EXTRACT_ALL = YES
54EXTRACT_PRIVATE = YES
55EXTRACT_STATIC = YES
56EXTRACT_LOCAL_CLASSES = YES
28c214e9 57EXTRACT_LOCAL_METHODS = NO
58EXTRACT_ANON_NSPACES = NO
b521659f 59HIDE_UNDOC_MEMBERS = NO
60HIDE_UNDOC_CLASSES = NO
61HIDE_FRIEND_COMPOUNDS = NO
62HIDE_IN_BODY_DOCS = YES
63INTERNAL_DOCS = NO
64CASE_SENSE_NAMES = YES
65HIDE_SCOPE_NAMES = NO
66SHOW_INCLUDE_FILES = YES
67INLINE_INFO = YES
68SORT_MEMBER_DOCS = YES
28c214e9 69SORT_BRIEF_DOCS = NO
70SORT_GROUP_NAMES = NO
71SORT_BY_SCOPE_NAME = NO
b521659f 72GENERATE_TODOLIST = YES
28c214e9 73GENERATE_TESTLIST = YES
74GENERATE_BUGLIST = YES
b521659f 75GENERATE_DEPRECATEDLIST= YES
76ENABLED_SECTIONS =
77MAX_INITIALIZER_LINES = 30
78SHOW_USED_FILES = YES
ebf7a8e8 79#SHOW_DIRECTORIES = NO
28c214e9 80SHOW_FILES = YES
81SHOW_NAMESPACES = YES
82FILE_VERSION_FILTER =
83LAYOUT_FILE =
b521659f 84#---------------------------------------------------------------------------
85# configuration options related to warning and progress messages
86#---------------------------------------------------------------------------
87QUIET = YES
88WARNINGS = YES
89WARN_IF_UNDOCUMENTED = YES
ccef02e8 90WARN_IF_DOC_ERROR = NO
28c214e9 91WARN_NO_PARAMDOC = NO
b521659f 92WARN_FORMAT = "$file:$line: $text"
93WARN_LOGFILE =
94#---------------------------------------------------------------------------
95# configuration options related to the input files
96#---------------------------------------------------------------------------
ebf7a8e8
TB
97INPUT = @HLT_doxy_input@
98
28c214e9 99INPUT_ENCODING = UTF-8
90ebac25 100
ebf7a8e8 101FILE_PATTERNS = *.h *.c *.cpp *.hpp *.cxx
b521659f 102RECURSIVE = YES
ebf7a8e8 103EXCLUDE = @HLT_doxy_source_exclude_paths@
2a083ac4 104
b521659f 105EXCLUDE_SYMLINKS = NO
106EXCLUDE_PATTERNS =
28c214e9 107EXCLUDE_SYMBOLS =
b521659f 108EXAMPLE_PATH =
109EXAMPLE_PATTERNS =
110EXAMPLE_RECURSIVE = NO
ebf7a8e8 111IMAGE_PATH = @HLT_doxy_image_path@
b521659f 112INPUT_FILTER =
28c214e9 113FILTER_PATTERNS =
b521659f 114FILTER_SOURCE_FILES = NO
115#---------------------------------------------------------------------------
116# configuration options related to source browsing
117#---------------------------------------------------------------------------
90ebac25 118SOURCE_BROWSER = YES
b521659f 119INLINE_SOURCES = NO
120STRIP_CODE_COMMENTS = YES
121REFERENCED_BY_RELATION = YES
122REFERENCES_RELATION = YES
28c214e9 123REFERENCES_LINK_SOURCE = YES
124USE_HTAGS = NO
b521659f 125VERBATIM_HEADERS = NO
126#---------------------------------------------------------------------------
127# configuration options related to the alphabetical class index
128#---------------------------------------------------------------------------
129ALPHABETICAL_INDEX = YES
130COLS_IN_ALPHA_INDEX = 5
131IGNORE_PREFIX =
132#---------------------------------------------------------------------------
133# configuration options related to the HTML output
134#---------------------------------------------------------------------------
135GENERATE_HTML = YES
136HTML_OUTPUT = html
137HTML_FILE_EXTENSION = .html
138HTML_HEADER =
139HTML_FOOTER =
140HTML_STYLESHEET =
ebf7a8e8 141#HTML_ALIGN_MEMBERS = YES
28c214e9 142HTML_DYNAMIC_SECTIONS = NO
143GENERATE_DOCSET = NO
144DOCSET_FEEDNAME =
145DOCSET_BUNDLE_ID =
b521659f 146GENERATE_HTMLHELP = NO
147CHM_FILE =
148HHC_LOCATION =
149GENERATE_CHI = NO
28c214e9 150CHM_INDEX_ENCODING =
b521659f 151BINARY_TOC = NO
152TOC_EXPAND = NO
28c214e9 153GENERATE_QHP = NO
154QCH_FILE =
155QHP_NAMESPACE =
156QHP_VIRTUAL_FOLDER = doc
157QHG_LOCATION =
b521659f 158DISABLE_INDEX = NO
159ENUM_VALUES_PER_LINE = 4
160GENERATE_TREEVIEW = NO
161TREEVIEW_WIDTH = 150
28c214e9 162FORMULA_FONTSIZE = 10
b521659f 163#---------------------------------------------------------------------------
164# configuration options related to the LaTeX output
165#---------------------------------------------------------------------------
e824c10d 166GENERATE_LATEX = NO
b521659f 167LATEX_OUTPUT = latex
168LATEX_CMD_NAME = latex
169MAKEINDEX_CMD_NAME = makeindex
170COMPACT_LATEX = YES
171PAPER_TYPE = a4wide
172EXTRA_PACKAGES =
173LATEX_HEADER =
174PDF_HYPERLINKS = YES
175USE_PDFLATEX = YES
176LATEX_BATCHMODE = NO
b22e91eb 177LATEX_HIDE_INDICES = YES
b521659f 178#---------------------------------------------------------------------------
179# configuration options related to the RTF output
180#---------------------------------------------------------------------------
181GENERATE_RTF = NO
182RTF_OUTPUT = rtf
183COMPACT_RTF = NO
184RTF_HYPERLINKS = NO
185RTF_STYLESHEET_FILE =
186RTF_EXTENSIONS_FILE =
187#---------------------------------------------------------------------------
188# configuration options related to the man page output
189#---------------------------------------------------------------------------
190GENERATE_MAN = NO
191MAN_OUTPUT = man
192MAN_EXTENSION = .3
193MAN_LINKS = NO
194#---------------------------------------------------------------------------
195# configuration options related to the XML output
196#---------------------------------------------------------------------------
197GENERATE_XML = NO
198XML_OUTPUT = xml
199XML_SCHEMA =
200XML_DTD =
201#---------------------------------------------------------------------------
202# configuration options for the AutoGen Definitions output
203#---------------------------------------------------------------------------
204GENERATE_AUTOGEN_DEF = NO
205#---------------------------------------------------------------------------
206# configuration options related to the Perl module output
207#---------------------------------------------------------------------------
208GENERATE_PERLMOD = NO
209PERLMOD_LATEX = NO
210PERLMOD_PRETTY = YES
211PERLMOD_MAKEVAR_PREFIX =
212#---------------------------------------------------------------------------
213# Configuration options related to the preprocessor
214#---------------------------------------------------------------------------
215ENABLE_PREPROCESSING = YES
216MACRO_EXPANSION = YES
217EXPAND_ONLY_PREDEF = NO
218SEARCH_INCLUDES = YES
219INCLUDE_PATH =
220INCLUDE_FILE_PATTERNS =
ebf7a8e8
TB
221PREDEFINED = ClassImp()= \
222 GPUd()=
b521659f 223EXPAND_AS_DEFINED =
224SKIP_FUNCTION_MACROS = YES
225#---------------------------------------------------------------------------
226# Configuration::addtions related to external references
227#---------------------------------------------------------------------------
228TAGFILES =
ebf7a8e8 229GENERATE_TAGFILE =
b521659f 230ALLEXTERNALS = NO
231EXTERNAL_GROUPS = YES
ebf7a8e8 232PERL_PATH =
b521659f 233#---------------------------------------------------------------------------
234# Configuration options related to the dot tool
235#---------------------------------------------------------------------------
236CLASS_DIAGRAMS = YES
237HIDE_UNDOC_RELATIONS = NO
ebf7a8e8
TB
238HAVE_DOT = @DOXYGEN_DOT_FOUND@
239DOT_FONTNAME = Sans
28c214e9 240DOT_FONTSIZE = 10
b521659f 241CLASS_GRAPH = YES
ebf7a8e8 242COLLABORATION_GRAPH = NO
28c214e9 243GROUP_GRAPHS = YES
b521659f 244UML_LOOK = YES
245TEMPLATE_RELATIONS = YES
246INCLUDE_GRAPH = YES
ebf7a8e8 247INCLUDED_BY_GRAPH = NO
b521659f 248CALL_GRAPH = YES
28c214e9 249CALLER_GRAPH = NO
b521659f 250GRAPHICAL_HIERARCHY = YES
28c214e9 251DIRECTORY_GRAPH = YES
b521659f 252DOT_IMAGE_FORMAT = png
ebf7a8e8
TB
253DOT_PATH = @DOXYGEN_DOT_PATH@
254#DOT_GRAPH_MAX_NODES = 100
b521659f 255DOTFILE_DIRS =
b521659f 256MAX_DOT_GRAPH_DEPTH = 0
257GENERATE_LEGEND = YES
258DOT_CLEANUP = YES
259#---------------------------------------------------------------------------
28c214e9 260# Configuration::additions related to the search engine
b521659f 261#---------------------------------------------------------------------------
262SEARCHENGINE = NO