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