• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#---------------------------------------------------------------------------
2# Project related configuration options
3#---------------------------------------------------------------------------
4DOXYFILE_ENCODING      = UTF-8
5PROJECT_NAME           = "docca"
6PROJECT_NUMBER         =
7PROJECT_BRIEF          = Documentation Library
8PROJECT_LOGO           =
9OUTPUT_DIRECTORY       =
10CREATE_SUBDIRS         = NO
11ALLOW_UNICODE_NAMES    = NO
12OUTPUT_LANGUAGE        = English
13BRIEF_MEMBER_DESC      = YES
14REPEAT_BRIEF           = YES
15ABBREVIATE_BRIEF       =
16ALWAYS_DETAILED_SEC    = YES
17INLINE_INHERITED_MEMB  = YES
18FULL_PATH_NAMES        = NO
19STRIP_FROM_PATH        = include/
20STRIP_FROM_INC_PATH    =
21SHORT_NAMES            = NO
22JAVADOC_AUTOBRIEF      = YES
23QT_AUTOBRIEF           = NO
24MULTILINE_CPP_IS_BRIEF = YES
25INHERIT_DOCS           = YES
26SEPARATE_MEMBER_PAGES  = NO
27TAB_SIZE               = 4
28ALIASES                =
29TCL_SUBST              =
30OPTIMIZE_OUTPUT_FOR_C  = NO
31OPTIMIZE_OUTPUT_JAVA   = NO
32OPTIMIZE_FOR_FORTRAN   = NO
33OPTIMIZE_OUTPUT_VHDL   = NO
34EXTENSION_MAPPING      =
35MARKDOWN_SUPPORT       = YES
36AUTOLINK_SUPPORT       = YES
37BUILTIN_STL_SUPPORT    = NO
38CPP_CLI_SUPPORT        = NO
39SIP_SUPPORT            = NO
40IDL_PROPERTY_SUPPORT   = YES
41DISTRIBUTE_GROUP_DOC   = NO
42GROUP_NESTED_COMPOUNDS = NO
43SUBGROUPING            = YES
44INLINE_GROUPED_CLASSES = NO
45INLINE_SIMPLE_STRUCTS  = NO
46TYPEDEF_HIDES_STRUCT   = NO
47LOOKUP_CACHE_SIZE      = 0
48
49#---------------------------------------------------------------------------
50# Build related configuration options
51#---------------------------------------------------------------------------
52EXTRACT_ALL            = YES
53EXTRACT_PRIVATE        = YES
54EXTRACT_PACKAGE        = NO
55EXTRACT_STATIC         = YES
56EXTRACT_LOCAL_CLASSES  = NO
57EXTRACT_LOCAL_METHODS  = NO
58EXTRACT_ANON_NSPACES   = NO
59HIDE_UNDOC_MEMBERS     = NO
60HIDE_UNDOC_CLASSES     = NO
61HIDE_FRIEND_COMPOUNDS  = NO
62HIDE_IN_BODY_DOCS      = NO
63INTERNAL_DOCS          = NO
64CASE_SENSE_NAMES       = YES
65HIDE_SCOPE_NAMES       = NO
66HIDE_COMPOUND_REFERENCE= NO
67SHOW_INCLUDE_FILES     = NO
68SHOW_GROUPED_MEMB_INC  = NO
69FORCE_LOCAL_INCLUDES   = NO
70INLINE_INFO            = NO
71SORT_MEMBER_DOCS       = NO
72SORT_BRIEF_DOCS        = NO
73SORT_MEMBERS_CTORS_1ST = YES
74SORT_GROUP_NAMES       = NO
75SORT_BY_SCOPE_NAME     = NO
76STRICT_PROTO_MATCHING  = NO
77GENERATE_TODOLIST      = NO
78GENERATE_TESTLIST      = NO
79GENERATE_BUGLIST       = NO
80GENERATE_DEPRECATEDLIST= NO
81ENABLED_SECTIONS       =
82MAX_INITIALIZER_LINES  = 30
83SHOW_USED_FILES        = NO
84SHOW_FILES             = NO
85SHOW_NAMESPACES        = NO
86FILE_VERSION_FILTER    =
87LAYOUT_FILE            =
88CITE_BIB_FILES         =
89
90#---------------------------------------------------------------------------
91# Configuration options related to warning and progress messages
92#---------------------------------------------------------------------------
93QUIET                  = NO
94WARNINGS               = YES
95WARN_IF_UNDOCUMENTED   = YES
96WARN_IF_DOC_ERROR      = YES
97WARN_NO_PARAMDOC       = NO
98WARN_AS_ERROR          = NO
99WARN_FORMAT            = "$file:$line: $text"
100WARN_LOGFILE           =
101
102#---------------------------------------------------------------------------
103# Configuration options related to the input files
104#---------------------------------------------------------------------------
105INPUT                  = include/docca/example.hpp
106
107INPUT_ENCODING         = UTF-8
108FILE_PATTERNS          =
109RECURSIVE              = NO
110EXCLUDE                =
111EXCLUDE_SYMLINKS       = NO
112EXCLUDE_PATTERNS       =
113EXCLUDE_SYMBOLS        =
114EXAMPLE_PATH           =
115EXAMPLE_PATTERNS       =
116EXAMPLE_RECURSIVE      = YES
117IMAGE_PATH             =
118INPUT_FILTER           =
119FILTER_PATTERNS        =
120FILTER_SOURCE_FILES    = NO
121FILTER_SOURCE_PATTERNS =
122USE_MDFILE_AS_MAINPAGE =
123
124#---------------------------------------------------------------------------
125# Configuration options related to source browsing
126#---------------------------------------------------------------------------
127SOURCE_BROWSER         = NO
128INLINE_SOURCES         = NO
129STRIP_CODE_COMMENTS    = YES
130REFERENCED_BY_RELATION = NO
131REFERENCES_RELATION    = NO
132REFERENCES_LINK_SOURCE = YES
133SOURCE_TOOLTIPS        = YES
134USE_HTAGS              = NO
135VERBATIM_HEADERS       = YES
136CLANG_ASSISTED_PARSING = NO
137CLANG_OPTIONS          =
138
139#---------------------------------------------------------------------------
140# Configuration options related to the alphabetical class index
141#---------------------------------------------------------------------------
142ALPHABETICAL_INDEX     = YES
143COLS_IN_ALPHA_INDEX    = 1
144IGNORE_PREFIX          =
145
146#---------------------------------------------------------------------------
147# Configuration options related to the HTML output
148#---------------------------------------------------------------------------
149GENERATE_HTML          = NO
150HTML_OUTPUT            = dhtm
151HTML_FILE_EXTENSION    = .html
152HTML_HEADER            =
153HTML_FOOTER            =
154HTML_STYLESHEET        =
155HTML_EXTRA_STYLESHEET  =
156HTML_EXTRA_FILES       =
157HTML_COLORSTYLE_HUE    = 220
158HTML_COLORSTYLE_SAT    = 100
159HTML_COLORSTYLE_GAMMA  = 80
160HTML_TIMESTAMP         = NO
161HTML_DYNAMIC_SECTIONS  = NO
162HTML_INDEX_NUM_ENTRIES = 100
163GENERATE_DOCSET        = NO
164DOCSET_FEEDNAME        = "Doxygen generated docs"
165DOCSET_BUNDLE_ID       = org.doxygen.Project
166DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
167DOCSET_PUBLISHER_NAME  = Publisher
168GENERATE_HTMLHELP      = NO
169CHM_FILE               =
170HHC_LOCATION           =
171GENERATE_CHI           = NO
172CHM_INDEX_ENCODING     =
173BINARY_TOC             = NO
174TOC_EXPAND             = NO
175GENERATE_QHP           = NO
176QCH_FILE               =
177QHP_NAMESPACE          = org.doxygen.Project
178QHP_VIRTUAL_FOLDER     = doc
179QHP_CUST_FILTER_NAME   =
180QHP_CUST_FILTER_ATTRS  =
181QHP_SECT_FILTER_ATTRS  =
182QHG_LOCATION           =
183GENERATE_ECLIPSEHELP   = NO
184ECLIPSE_DOC_ID         = org.doxygen.Project
185DISABLE_INDEX          = NO
186GENERATE_TREEVIEW      = NO
187ENUM_VALUES_PER_LINE   = 4
188TREEVIEW_WIDTH         = 250
189EXT_LINKS_IN_WINDOW    = NO
190FORMULA_FONTSIZE       = 10
191FORMULA_TRANSPARENT    = YES
192USE_MATHJAX            = NO
193MATHJAX_FORMAT         = HTML-CSS
194MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
195MATHJAX_EXTENSIONS     =
196MATHJAX_CODEFILE       =
197SEARCHENGINE           = YES
198SERVER_BASED_SEARCH    = NO
199EXTERNAL_SEARCH        = NO
200SEARCHENGINE_URL       =
201SEARCHDATA_FILE        = searchdata.xml
202EXTERNAL_SEARCH_ID     =
203EXTRA_SEARCH_MAPPINGS  =
204
205#---------------------------------------------------------------------------
206# Configuration options related to the LaTeX output
207#---------------------------------------------------------------------------
208GENERATE_LATEX         = NO
209LATEX_OUTPUT           = latex
210LATEX_CMD_NAME         = latex
211MAKEINDEX_CMD_NAME     = makeindex
212COMPACT_LATEX          = NO
213PAPER_TYPE             = a4
214EXTRA_PACKAGES         =
215LATEX_HEADER           =
216LATEX_FOOTER           =
217LATEX_EXTRA_STYLESHEET =
218LATEX_EXTRA_FILES      =
219PDF_HYPERLINKS         = YES
220USE_PDFLATEX           = YES
221LATEX_BATCHMODE        = NO
222LATEX_HIDE_INDICES     = NO
223LATEX_SOURCE_CODE      = NO
224LATEX_BIB_STYLE        = plain
225LATEX_TIMESTAMP        = NO
226
227#---------------------------------------------------------------------------
228# Configuration options related to the RTF output
229#---------------------------------------------------------------------------
230GENERATE_RTF           = NO
231RTF_OUTPUT             = rtf
232COMPACT_RTF            = NO
233RTF_HYPERLINKS         = NO
234RTF_STYLESHEET_FILE    =
235RTF_EXTENSIONS_FILE    =
236RTF_SOURCE_CODE        = NO
237
238#---------------------------------------------------------------------------
239# Configuration options related to the man page output
240#---------------------------------------------------------------------------
241GENERATE_MAN           = NO
242MAN_OUTPUT             = man
243MAN_EXTENSION          = .3
244MAN_SUBDIR             =
245MAN_LINKS              = NO
246
247#---------------------------------------------------------------------------
248# Configuration options related to the XML output
249#---------------------------------------------------------------------------
250GENERATE_XML           = YES
251XML_OUTPUT             = temp/
252XML_PROGRAMLISTING     = NO
253
254#---------------------------------------------------------------------------
255# Configuration options related to the DOCBOOK output
256#---------------------------------------------------------------------------
257GENERATE_DOCBOOK       = NO
258DOCBOOK_OUTPUT         = docbook
259DOCBOOK_PROGRAMLISTING = NO
260
261#---------------------------------------------------------------------------
262# Configuration options for the AutoGen Definitions output
263#---------------------------------------------------------------------------
264GENERATE_AUTOGEN_DEF   = NO
265GENERATE_PERLMOD       = NO
266PERLMOD_LATEX          = NO
267PERLMOD_PRETTY         = YES
268PERLMOD_MAKEVAR_PREFIX =
269
270#---------------------------------------------------------------------------
271# Configuration options related to the preprocessor
272#---------------------------------------------------------------------------
273ENABLE_PREPROCESSING   = YES
274MACRO_EXPANSION        = YES
275EXPAND_ONLY_PREDEF     = YES
276SEARCH_INCLUDES        = YES
277INCLUDE_PATH           =
278INCLUDE_FILE_PATTERNS  =
279PREDEFINED             = DOXYGEN \
280                         GENERATING_DOCS \
281                         _MSC_VER
282
283EXPAND_AS_DEFINED      =
284SKIP_FUNCTION_MACROS   = YES
285
286#---------------------------------------------------------------------------
287# Configuration options related to external references
288#---------------------------------------------------------------------------
289TAGFILES               =
290GENERATE_TAGFILE       =
291ALLEXTERNALS           = NO
292EXTERNAL_GROUPS        = YES
293EXTERNAL_PAGES         = YES
294PERL_PATH              = /usr/bin/perl
295
296#---------------------------------------------------------------------------
297# Configuration options related to the dot tool
298#---------------------------------------------------------------------------
299CLASS_DIAGRAMS         = NO
300MSCGEN_PATH            =
301DIA_PATH               =
302HIDE_UNDOC_RELATIONS   = YES
303HAVE_DOT               = NO
304DOT_NUM_THREADS        = 0
305DOT_FONTNAME           = Helvetica
306DOT_FONTSIZE           = 10
307DOT_FONTPATH           =
308CLASS_GRAPH            = YES
309COLLABORATION_GRAPH    = YES
310GROUP_GRAPHS           = YES
311UML_LOOK               = NO
312UML_LIMIT_NUM_FIELDS   = 10
313TEMPLATE_RELATIONS     = NO
314INCLUDE_GRAPH          = YES
315INCLUDED_BY_GRAPH      = YES
316CALL_GRAPH             = NO
317CALLER_GRAPH           = NO
318GRAPHICAL_HIERARCHY    = YES
319DIRECTORY_GRAPH        = YES
320DOT_IMAGE_FORMAT       = png
321INTERACTIVE_SVG        = NO
322DOT_PATH               =
323DOTFILE_DIRS           =
324MSCFILE_DIRS           =
325DIAFILE_DIRS           =
326PLANTUML_JAR_PATH      =
327PLANTUML_INCLUDE_PATH  =
328DOT_GRAPH_MAX_NODES    = 50
329MAX_DOT_GRAPH_DEPTH    = 0
330DOT_TRANSPARENT        = NO
331DOT_MULTI_TARGETS      = NO
332GENERATE_LEGEND        = YES
333DOT_CLEANUP            = YES
334