add Doxyfile template
[diogenes.git] / Doxyfile.in
CommitLineData
341d323e
JL
1#---------------------------------------------------------------------------
2# Project related configuration options
3#---------------------------------------------------------------------------
4PROJECT_NAME = Diogenes
5PROJECT_NUMBER = @VERSION@
6OUTPUT_DIRECTORY = apidocs
7OUTPUT_LANGUAGE = English
8USE_WINDOWS_ENCODING = NO
9BRIEF_MEMBER_DESC = YES
10REPEAT_BRIEF = YES
11ABBREVIATE_BRIEF =
12ALWAYS_DETAILED_SEC = NO
13INLINE_INHERITED_MEMB = NO
14FULL_PATH_NAMES = NO
15STRIP_FROM_PATH =
16SHORT_NAMES = NO
17JAVADOC_AUTOBRIEF = NO
18MULTILINE_CPP_IS_BRIEF = NO
19DETAILS_AT_TOP = NO
20INHERIT_DOCS = YES
21DISTRIBUTE_GROUP_DOC = NO
22TAB_SIZE = 8
23ALIASES =
24OPTIMIZE_OUTPUT_FOR_C = NO
25OPTIMIZE_OUTPUT_JAVA = NO
26SUBGROUPING = YES
27#---------------------------------------------------------------------------
28# Build related configuration options
29#---------------------------------------------------------------------------
30EXTRACT_ALL = NO
31EXTRACT_PRIVATE = NO
32EXTRACT_STATIC = NO
33EXTRACT_LOCAL_CLASSES = YES
34HIDE_UNDOC_MEMBERS = NO
35HIDE_UNDOC_CLASSES = NO
36HIDE_FRIEND_COMPOUNDS = NO
37HIDE_IN_BODY_DOCS = NO
38INTERNAL_DOCS = NO
39CASE_SENSE_NAMES = YES
40HIDE_SCOPE_NAMES = NO
41SHOW_INCLUDE_FILES = YES
42INLINE_INFO = YES
43SORT_MEMBER_DOCS = YES
44SORT_BRIEF_DOCS = NO
45SORT_BY_SCOPE_NAME = NO
46GENERATE_TODOLIST = YES
47GENERATE_TESTLIST = YES
48GENERATE_BUGLIST = 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 = NO
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 =
66FILE_PATTERNS = *.php
67RECURSIVE = YES
68EXCLUDE =
69EXCLUDE_SYMLINKS = NO
70EXCLUDE_PATTERNS = \
71 */include/admin/* \
72 */include/HTTP/* \
73 */include/Text/* \
74 */include/phplayersmenu/* \
75 */testing/* \
76 */{arch}/*
77EXAMPLE_PATH =
78EXAMPLE_PATTERNS =
79EXAMPLE_RECURSIVE = NO
80IMAGE_PATH =
81INPUT_FILTER =
82FILTER_SOURCE_FILES = NO
83#---------------------------------------------------------------------------
84# configuration options related to source browsing
85#---------------------------------------------------------------------------
86SOURCE_BROWSER = NO
87INLINE_SOURCES = NO
88STRIP_CODE_COMMENTS = YES
89REFERENCED_BY_RELATION = YES
90REFERENCES_RELATION = YES
91VERBATIM_HEADERS = YES
92#---------------------------------------------------------------------------
93# configuration options related to the alphabetical class index
94#---------------------------------------------------------------------------
95ALPHABETICAL_INDEX = NO
96COLS_IN_ALPHA_INDEX = 5
97IGNORE_PREFIX =
98#---------------------------------------------------------------------------
99# configuration options related to the HTML output
100#---------------------------------------------------------------------------
101GENERATE_HTML = YES
102HTML_OUTPUT = html
103HTML_FILE_EXTENSION = .html
104HTML_HEADER =
105HTML_FOOTER =
106HTML_STYLESHEET =
107HTML_ALIGN_MEMBERS = YES
108GENERATE_HTMLHELP = NO
109CHM_FILE =
110HHC_LOCATION =
111GENERATE_CHI = NO
112BINARY_TOC = NO
113TOC_EXPAND = NO
114DISABLE_INDEX = NO
115ENUM_VALUES_PER_LINE = 4
116GENERATE_TREEVIEW = YES
117TREEVIEW_WIDTH = 250
118#---------------------------------------------------------------------------
119# configuration options related to the LaTeX output
120#---------------------------------------------------------------------------
121GENERATE_LATEX = NO
122LATEX_OUTPUT = latex
123LATEX_CMD_NAME = latex
124MAKEINDEX_CMD_NAME = makeindex
125COMPACT_LATEX = NO
126PAPER_TYPE = a4wide
127EXTRA_PACKAGES =
128LATEX_HEADER =
129PDF_HYPERLINKS = NO
130USE_PDFLATEX = NO
131LATEX_BATCHMODE = NO
132LATEX_HIDE_INDICES = NO
133#---------------------------------------------------------------------------
134# configuration options related to the RTF output
135#---------------------------------------------------------------------------
136GENERATE_RTF = NO
137RTF_OUTPUT = rtf
138COMPACT_RTF = NO
139RTF_HYPERLINKS = NO
140RTF_STYLESHEET_FILE =
141RTF_EXTENSIONS_FILE =
142#---------------------------------------------------------------------------
143# configuration options related to the man page output
144#---------------------------------------------------------------------------
145GENERATE_MAN = NO
146MAN_OUTPUT = man
147MAN_EXTENSION = .3
148MAN_LINKS = NO
149#---------------------------------------------------------------------------
150# configuration options related to the XML output
151#---------------------------------------------------------------------------
152GENERATE_XML = NO
153XML_OUTPUT = xml
154XML_SCHEMA =
155XML_DTD =
156XML_PROGRAMLISTING = YES
157#---------------------------------------------------------------------------
158# configuration options for the AutoGen Definitions output
159#---------------------------------------------------------------------------
160GENERATE_AUTOGEN_DEF = NO
161#---------------------------------------------------------------------------
162# configuration options related to the Perl module output
163#---------------------------------------------------------------------------
164GENERATE_PERLMOD = NO
165PERLMOD_LATEX = NO
166PERLMOD_PRETTY = YES
167PERLMOD_MAKEVAR_PREFIX =
168#---------------------------------------------------------------------------
169# Configuration options related to the preprocessor
170#---------------------------------------------------------------------------
171ENABLE_PREPROCESSING = NO
172MACRO_EXPANSION = NO
173EXPAND_ONLY_PREDEF = NO
174SEARCH_INCLUDES = YES
175INCLUDE_PATH =
176INCLUDE_FILE_PATTERNS =
177PREDEFINED =
178EXPAND_AS_DEFINED =
179SKIP_FUNCTION_MACROS = YES
180#---------------------------------------------------------------------------
181# Configuration::additions related to external references
182#---------------------------------------------------------------------------
183TAGFILES =
184GENERATE_TAGFILE =
185ALLEXTERNALS = NO
186EXTERNAL_GROUPS = YES
187PERL_PATH = /usr/bin/perl
188#---------------------------------------------------------------------------
189# Configuration options related to the dot tool
190#---------------------------------------------------------------------------
191CLASS_DIAGRAMS = YES
192HIDE_UNDOC_RELATIONS = YES
193HAVE_DOT = YES
194CLASS_GRAPH = YES
195COLLABORATION_GRAPH = YES
196UML_LOOK = NO
197TEMPLATE_RELATIONS = NO
198INCLUDE_GRAPH = YES
199INCLUDED_BY_GRAPH = YES
200CALL_GRAPH = YES
201GRAPHICAL_HIERARCHY = YES
202DOT_IMAGE_FORMAT = png
203DOT_PATH =
204DOTFILE_DIRS =
205MAX_DOT_GRAPH_WIDTH = 1024
206MAX_DOT_GRAPH_HEIGHT = 1024
207MAX_DOT_GRAPH_DEPTH = 0
208GENERATE_LEGEND = YES
209DOT_CLEANUP = YES
210#---------------------------------------------------------------------------
211# Configuration::additions related to the search engine
212#---------------------------------------------------------------------------
213SEARCHENGINE = YES