Merge branch 'master' of http://git.fredemmott.co.uk/repo/yanihp
[jkt-jerboa.git] / Doxyfile.cmake
blob3e1ba10eda8e47aad7ff03942e44988cfd697c32
1 # Doxyfile 1.5.5
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = Jerboa
8 PROJECT_NUMBER         = 
9 OUTPUT_DIRECTORY       = doc
10 CREATE_SUBDIRS         = NO
11 OUTPUT_LANGUAGE        = English
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       = "The $name class" \
15                          "The $name widget" \
16                          "The $name file" \
17                          is \
18                          provides \
19                          specifies \
20                          contains \
21                          represents \
22                          a \
23                          an \
24                          the
25 ALWAYS_DETAILED_SEC    = NO
26 INLINE_INHERITED_MEMB  = NO
27 FULL_PATH_NAMES        = NO
28 STRIP_FROM_PATH        = 
29 STRIP_FROM_INC_PATH    = 
30 SHORT_NAMES            = NO
31 JAVADOC_AUTOBRIEF      = YES
32 QT_AUTOBRIEF           = NO
33 MULTILINE_CPP_IS_BRIEF = NO
34 DETAILS_AT_TOP         = NO
35 INHERIT_DOCS           = YES
36 SEPARATE_MEMBER_PAGES  = NO
37 TAB_SIZE               = 8
38 ALIASES                = 
39 OPTIMIZE_OUTPUT_FOR_C  = YES
40 OPTIMIZE_OUTPUT_JAVA   = NO
41 OPTIMIZE_FOR_FORTRAN   = NO
42 OPTIMIZE_OUTPUT_VHDL   = NO
43 BUILTIN_STL_SUPPORT    = NO
44 CPP_CLI_SUPPORT        = NO
45 SIP_SUPPORT            = NO
46 DISTRIBUTE_GROUP_DOC   = NO
47 SUBGROUPING            = YES
48 TYPEDEF_HIDES_STRUCT   = NO
49 #---------------------------------------------------------------------------
50 # Build related configuration options
51 #---------------------------------------------------------------------------
52 EXTRACT_ALL            = NO
53 EXTRACT_PRIVATE        = NO
54 EXTRACT_STATIC         = NO
55 EXTRACT_LOCAL_CLASSES  = YES
56 EXTRACT_LOCAL_METHODS  = NO
57 EXTRACT_ANON_NSPACES   = NO
58 HIDE_UNDOC_MEMBERS     = NO
59 HIDE_UNDOC_CLASSES     = NO
60 HIDE_FRIEND_COMPOUNDS  = NO
61 HIDE_IN_BODY_DOCS      = NO
62 INTERNAL_DOCS          = NO
63 CASE_SENSE_NAMES       = YES
64 HIDE_SCOPE_NAMES       = NO
65 SHOW_INCLUDE_FILES     = YES
66 INLINE_INFO            = YES
67 SORT_MEMBER_DOCS       = YES
68 SORT_BRIEF_DOCS        = NO
69 SORT_GROUP_NAMES       = NO
70 SORT_BY_SCOPE_NAME     = NO
71 GENERATE_TODOLIST      = YES
72 GENERATE_TESTLIST      = YES
73 GENERATE_BUGLIST       = YES
74 GENERATE_DEPRECATEDLIST= YES
75 ENABLED_SECTIONS       = 
76 MAX_INITIALIZER_LINES  = 30
77 SHOW_USED_FILES        = YES
78 SHOW_DIRECTORIES       = NO
79 FILE_VERSION_FILTER    = 
80 #---------------------------------------------------------------------------
81 # configuration options related to warning and progress messages
82 #---------------------------------------------------------------------------
83 QUIET                  = NO
84 WARNINGS               = YES
85 WARN_IF_UNDOCUMENTED   = YES
86 WARN_IF_DOC_ERROR      = YES
87 WARN_NO_PARAMDOC       = NO
88 WARN_FORMAT            = "$file:$line: $text"
89 WARN_LOGFILE           = 
90 #---------------------------------------------------------------------------
91 # configuration options related to the input files
92 #---------------------------------------------------------------------------
93 INPUT                  = ${CMAKE_SOURCE_DIR}/src/ \
94                          ${CMAKE_SOURCE_DIR}/include/
95 INPUT_ENCODING         = UTF-8
96 FILE_PATTERNS          = *.c \
97                          *.cc \
98                          *.cxx \
99                          *.cpp \
100                          *.c++ \
101                          *.d \
102                          *.java \
103                          *.ii \
104                          *.ixx \
105                          *.ipp \
106                          *.i++ \
107                          *.inl \
108                          *.h \
109                          *.hh \
110                          *.hxx \
111                          *.hpp \
112                          *.h++ \
113                          *.idl \
114                          *.odl \
115                          *.cs \
116                          *.php \
117                          *.php3 \
118                          *.inc \
119                          *.m \
120                          *.mm \
121                          *.dox \
122                          *.py \
123                          *.f90 \
124                          *.f \
125                          *.vhd \
126                          *.vhdl \
127                          *.C \
128                          *.CC \
129                          *.C++ \
130                          *.II \
131                          *.I++ \
132                          *.H \
133                          *.HH \
134                          *.H++ \
135                          *.CS \
136                          *.PHP \
137                          *.PHP3 \
138                          *.M \
139                          *.MM \
140                          *.PY \
141                          *.F90 \
142                          *.F \
143                          *.VHD \
144                          *.VHDL
145 RECURSIVE              = YES
146 EXCLUDE                = 
147 EXCLUDE_SYMLINKS       = NO
148 EXCLUDE_PATTERNS       = *_p.h \
149                          *_p.cpp \
150                                                  ${CMAKE_SOURCE_DIR}/src/plugins
151 EXCLUDE_SYMBOLS        = 
152 EXAMPLE_PATH           = 
153 EXAMPLE_PATTERNS       = *
154 EXAMPLE_RECURSIVE      = NO
155 IMAGE_PATH             = 
156 INPUT_FILTER           = 
157 FILTER_PATTERNS        = 
158 FILTER_SOURCE_FILES    = NO
159 #---------------------------------------------------------------------------
160 # configuration options related to source browsing
161 #---------------------------------------------------------------------------
162 SOURCE_BROWSER         = YES
163 INLINE_SOURCES         = NO
164 STRIP_CODE_COMMENTS    = YES
165 REFERENCED_BY_RELATION = NO
166 REFERENCES_RELATION    = NO
167 REFERENCES_LINK_SOURCE = YES
168 USE_HTAGS              = NO
169 VERBATIM_HEADERS       = YES
170 #---------------------------------------------------------------------------
171 # configuration options related to the alphabetical class index
172 #---------------------------------------------------------------------------
173 ALPHABETICAL_INDEX     = YES
174 COLS_IN_ALPHA_INDEX    = 5
175 IGNORE_PREFIX          = 
176 #---------------------------------------------------------------------------
177 # configuration options related to the HTML output
178 #---------------------------------------------------------------------------
179 GENERATE_HTML          = YES
180 HTML_OUTPUT            = html
181 HTML_FILE_EXTENSION    = .html
182 HTML_HEADER            = 
183 HTML_FOOTER            = 
184 HTML_STYLESHEET        = 
185 HTML_ALIGN_MEMBERS     = YES
186 GENERATE_HTMLHELP      = NO
187 GENERATE_DOCSET        = NO
188 DOCSET_FEEDNAME        = "Doxygen generated docs"
189 DOCSET_BUNDLE_ID       = org.doxygen.Project
190 HTML_DYNAMIC_SECTIONS  = YES
191 CHM_FILE               = 
192 HHC_LOCATION           = 
193 GENERATE_CHI           = NO
194 BINARY_TOC             = NO
195 TOC_EXPAND             = NO
196 DISABLE_INDEX          = NO
197 ENUM_VALUES_PER_LINE   = 4
198 GENERATE_TREEVIEW      = NO
199 TREEVIEW_WIDTH         = 250
200 #---------------------------------------------------------------------------
201 # configuration options related to the LaTeX output
202 #---------------------------------------------------------------------------
203 GENERATE_LATEX         = YES
204 LATEX_OUTPUT           = latex
205 LATEX_CMD_NAME         = latex
206 MAKEINDEX_CMD_NAME     = makeindex
207 COMPACT_LATEX          = NO
208 PAPER_TYPE             = a4wide
209 EXTRA_PACKAGES         = 
210 LATEX_HEADER           = 
211 PDF_HYPERLINKS         = YES
212 USE_PDFLATEX           = YES
213 LATEX_BATCHMODE        = NO
214 LATEX_HIDE_INDICES     = NO
215 #---------------------------------------------------------------------------
216 # configuration options related to the RTF output
217 #---------------------------------------------------------------------------
218 GENERATE_RTF           = NO
219 RTF_OUTPUT             = rtf
220 COMPACT_RTF            = NO
221 RTF_HYPERLINKS         = NO
222 RTF_STYLESHEET_FILE    = 
223 RTF_EXTENSIONS_FILE    = 
224 #---------------------------------------------------------------------------
225 # configuration options related to the man page output
226 #---------------------------------------------------------------------------
227 GENERATE_MAN           = NO
228 MAN_OUTPUT             = man
229 MAN_EXTENSION          = .3
230 MAN_LINKS              = NO
231 #---------------------------------------------------------------------------
232 # configuration options related to the XML output
233 #---------------------------------------------------------------------------
234 GENERATE_XML           = NO
235 XML_OUTPUT             = xml
236 XML_SCHEMA             = 
237 XML_DTD                = 
238 XML_PROGRAMLISTING     = YES
239 #---------------------------------------------------------------------------
240 # configuration options for the AutoGen Definitions output
241 #---------------------------------------------------------------------------
242 GENERATE_AUTOGEN_DEF   = NO
243 #---------------------------------------------------------------------------
244 # configuration options related to the Perl module output
245 #---------------------------------------------------------------------------
246 GENERATE_PERLMOD       = NO
247 PERLMOD_LATEX          = NO
248 PERLMOD_PRETTY         = YES
249 PERLMOD_MAKEVAR_PREFIX = 
250 #---------------------------------------------------------------------------
251 # Configuration options related to the preprocessor   
252 #---------------------------------------------------------------------------
253 ENABLE_PREPROCESSING   = YES
254 MACRO_EXPANSION        = NO
255 EXPAND_ONLY_PREDEF     = NO
256 SEARCH_INCLUDES        = YES
257 INCLUDE_PATH           = 
258 INCLUDE_FILE_PATTERNS  = 
259 PREDEFINED             = 
260 EXPAND_AS_DEFINED      = 
261 SKIP_FUNCTION_MACROS   = YES
262 #---------------------------------------------------------------------------
263 # Configuration::additions related to external references   
264 #---------------------------------------------------------------------------
265 TAGFILES               = 
266 GENERATE_TAGFILE       = 
267 ALLEXTERNALS           = NO
268 EXTERNAL_GROUPS        = YES
269 PERL_PATH              = /usr/bin/perl
270 #---------------------------------------------------------------------------
271 # Configuration options related to the dot tool   
272 #---------------------------------------------------------------------------
273 CLASS_DIAGRAMS         = YES
274 MSCGEN_PATH            = 
275 HIDE_UNDOC_RELATIONS   = YES
276 HAVE_DOT               = NO
277 CLASS_GRAPH            = YES
278 COLLABORATION_GRAPH    = YES
279 GROUP_GRAPHS           = YES
280 UML_LOOK               = NO
281 TEMPLATE_RELATIONS     = NO
282 INCLUDE_GRAPH          = YES
283 INCLUDED_BY_GRAPH      = YES
284 CALL_GRAPH             = NO
285 CALLER_GRAPH           = NO
286 GRAPHICAL_HIERARCHY    = YES
287 DIRECTORY_GRAPH        = YES
288 DOT_IMAGE_FORMAT       = png
289 DOT_PATH               = 
290 DOTFILE_DIRS           = 
291 DOT_GRAPH_MAX_NODES    = 50
292 MAX_DOT_GRAPH_DEPTH    = 1000
293 DOT_TRANSPARENT        = YES
294 DOT_MULTI_TARGETS      = NO
295 GENERATE_LEGEND        = YES
296 DOT_CLEANUP            = YES
297 #---------------------------------------------------------------------------
298 # Configuration::additions related to the search engine   
299 #---------------------------------------------------------------------------
300 SEARCHENGINE           = NO