summaryrefslogtreecommitdiff
path: root/legacy/eobj/doc
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2012-04-16 12:36:42 +0000
committerTom Hacohen <tom@stosb.com>2012-04-16 12:36:42 +0000
commit809a7d4e1ec7f2f917e7e47fd2c460a85d7d49ea (patch)
treef1bd6a44477cd6e9d2b870da56ac80de3ec2ce68 /legacy/eobj/doc
parent23742813318069c02d05e4807ac19729c9618f08 (diff)
Eobj: Initial doxygen commit.
SVN revision: 70227
Diffstat (limited to 'legacy/eobj/doc')
-rw-r--r--legacy/eobj/doc/CMakeLists.txt7
-rw-r--r--legacy/eobj/doc/Doxyfile.in1693
-rw-r--r--legacy/eobj/doc/e.css273
-rw-r--r--legacy/eobj/doc/foot.html20
-rw-r--r--legacy/eobj/doc/head.html67
-rw-r--r--legacy/eobj/doc/img/e.pngbin0 -> 3825 bytes
-rw-r--r--legacy/eobj/doc/img/edoxy.css483
-rw-r--r--legacy/eobj/doc/img/foot_bg.pngbin0 -> 173 bytes
-rw-r--r--legacy/eobj/doc/img/head_bg.pngbin0 -> 214 bytes
-rw-r--r--legacy/eobj/doc/img/header_menu_background.pngbin0 -> 192 bytes
-rw-r--r--legacy/eobj/doc/img/header_menu_background_last.pngbin0 -> 637 bytes
-rw-r--r--legacy/eobj/doc/img/header_menu_unselected_background.pngbin0 -> 1596 bytes
-rw-r--r--legacy/eobj/doc/img/logo.pngbin0 -> 3825 bytes
-rw-r--r--legacy/eobj/doc/img/menu_bg.pngbin0 -> 192 bytes
-rw-r--r--legacy/eobj/doc/img/menu_bg_current.pngbin0 -> 1200 bytes
-rw-r--r--legacy/eobj/doc/img/menu_bg_hover.pngbin0 -> 3278 bytes
-rw-r--r--legacy/eobj/doc/img/menu_bg_last.pngbin0 -> 637 bytes
-rw-r--r--legacy/eobj/doc/img/menu_bg_unsel.pngbin0 -> 1596 bytes
18 files changed, 2543 insertions, 0 deletions
diff --git a/legacy/eobj/doc/CMakeLists.txt b/legacy/eobj/doc/CMakeLists.txt
new file mode 100644
index 0000000000..090615110b
--- /dev/null
+++ b/legacy/eobj/doc/CMakeLists.txt
@@ -0,0 +1,7 @@
1include(UseDoxygen OPTIONAL)
2
3add_custom_target(__copy_img COMMAND ${CMAKE_COMMAND} -E copy_directory
4 ${CMAKE_CURRENT_SOURCE_DIR}/img/
5 ${CMAKE_CURRENT_BINARY_DIR}/html/)
6
7add_dependencies(doc __copy_img)
diff --git a/legacy/eobj/doc/Doxyfile.in b/legacy/eobj/doc/Doxyfile.in
new file mode 100644
index 0000000000..958a757052
--- /dev/null
+++ b/legacy/eobj/doc/Doxyfile.in
@@ -0,0 +1,1693 @@
1# Doxyfile 1.7.3
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a hash (#) is considered a comment and will be ignored.
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ").
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26# by quotes) that should identify the project.
27
28PROJECT_NAME = Eobj
29
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
32# if some version control system is used.
33
34PROJECT_NUMBER = @PACKAGE_VERSION@
35
36# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
37
38PROJECT_BRIEF =
39
40# With the PROJECT_LOGO tag one can specify an logo or icon that is
41# included in the documentation. The maximum height of the logo should not
42# exceed 55 pixels and the maximum width should not exceed 200 pixels.
43# Doxygen will copy the logo to the output directory.
44
45PROJECT_LOGO =
46
47# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
48# base path where the generated documentation will be put.
49# If a relative path is entered, it will be relative to the location
50# where doxygen was started. If left blank the current directory will be used.
51
52OUTPUT_DIRECTORY = .
53
54# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
55# 4096 sub-directories (in 2 levels) under the output directory of each output
56# format and will distribute the generated files over these directories.
57# Enabling this option can be useful when feeding doxygen a huge amount of
58# source files, where putting all generated files in the same directory would
59# otherwise cause performance problems for the file system.
60
61CREATE_SUBDIRS = NO
62
63# The OUTPUT_LANGUAGE tag is used to specify the language in which all
64# documentation generated by doxygen is written. Doxygen will use this
65# information to generate all constant output in the proper language.
66# The default language is English, other supported languages are:
67# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
68# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
69# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
70# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
71# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
72# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
73
74OUTPUT_LANGUAGE = English
75
76# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
77# include brief member descriptions after the members that are listed in
78# the file and class documentation (similar to JavaDoc).
79# Set to NO to disable this.
80
81BRIEF_MEMBER_DESC = YES
82
83# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
84# the brief description of a member or function before the detailed description.
85# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86# brief descriptions will be completely suppressed.
87
88REPEAT_BRIEF = YES
89
90# This tag implements a quasi-intelligent brief description abbreviator
91# that is used to form the text in various listings. Each string
92# in this list, if found as the leading text of the brief description, will be
93# stripped from the text and the result after processing the whole list, is
94# used as the annotated text. Otherwise, the brief description is used as-is.
95# If left blank, the following values are used ("$name" is automatically
96# replaced with the name of the entity): "The $name class" "The $name widget"
97# "The $name file" "is" "provides" "specifies" "contains"
98# "represents" "a" "an" "the"
99
100ABBREVIATE_BRIEF =
101
102# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
103# Doxygen will generate a detailed section even if there is only a brief
104# description.
105
106ALWAYS_DETAILED_SEC = NO
107
108# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
109# inherited members of a class in the documentation of that class as if those
110# members were ordinary class members. Constructors, destructors and assignment
111# operators of the base classes will not be shown.
112
113INLINE_INHERITED_MEMB = NO
114
115# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
116# path before files name in the file list and in the header files. If set
117# to NO the shortest path that makes the file name unique will be used.
118
119FULL_PATH_NAMES = NO
120
121# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
122# can be used to strip a user-defined part of the path. Stripping is
123# only done if one of the specified strings matches the left-hand part of
124# the path. The tag can be used to show relative paths in the file list.
125# If left blank the directory from which doxygen is run is used as the
126# path to strip.
127
128STRIP_FROM_PATH =
129
130# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
131# the path mentioned in the documentation of a class, which tells
132# the reader which header file to include in order to use a class.
133# If left blank only the name of the header file containing the class
134# definition is used. Otherwise one should specify the include paths that
135# are normally passed to the compiler using the -I flag.
136
137STRIP_FROM_INC_PATH =
138
139# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
140# (but less readable) file names. This can be useful if your file system
141# doesn't support long names like on DOS, Mac, or CD-ROM.
142
143SHORT_NAMES = NO
144
145# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
146# will interpret the first line (until the first dot) of a JavaDoc-style
147# comment as the brief description. If set to NO, the JavaDoc
148# comments will behave just like regular Qt-style comments
149# (thus requiring an explicit @brief command for a brief description.)
150
151JAVADOC_AUTOBRIEF = YES
152
153# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
154# interpret the first line (until the first dot) of a Qt-style
155# comment as the brief description. If set to NO, the comments
156# will behave just like regular Qt-style comments (thus requiring
157# an explicit \brief command for a brief description.)
158
159QT_AUTOBRIEF = NO
160
161# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
162# treat a multi-line C++ special comment block (i.e. a block of //! or ///
163# comments) as a brief description. This used to be the default behaviour.
164# The new default is to treat a multi-line C++ comment block as a detailed
165# description. Set this tag to YES if you prefer the old behaviour instead.
166
167MULTILINE_CPP_IS_BRIEF = NO
168
169# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
170# member inherits the documentation from any documented member that it
171# re-implements.
172
173INHERIT_DOCS = YES
174
175# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
176# a new page for each member. If set to NO, the documentation of a member will
177# be part of the file/class/namespace that contains it.
178
179SEPARATE_MEMBER_PAGES = NO
180
181# The TAB_SIZE tag can be used to set the number of spaces in a tab.
182# Doxygen uses this value to replace tabs by spaces in code fragments.
183
184TAB_SIZE = 8
185
186# This tag can be used to specify a number of aliases that acts
187# as commands in the documentation. An alias has the form "name=value".
188# For example adding "sideeffect=\par Side Effects:\n" will allow you to
189# put the command \sideeffect (or @sideeffect) in the documentation, which
190# will result in a user-defined paragraph with heading "Side Effects:".
191# You can put \n's in the value part of an alias to insert newlines.
192
193ALIASES =
194
195# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
196# sources only. Doxygen will then generate output that is more tailored for C.
197# For instance, some of the names that are used will be different. The list
198# of all members will be omitted, etc.
199
200OPTIMIZE_OUTPUT_FOR_C = YES
201
202# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
203# sources only. Doxygen will then generate output that is more tailored for
204# Java. For instance, namespaces will be presented as packages, qualified
205# scopes will look different, etc.
206
207OPTIMIZE_OUTPUT_JAVA = NO
208
209# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
210# sources only. Doxygen will then generate output that is more tailored for
211# Fortran.
212
213OPTIMIZE_FOR_FORTRAN = NO
214
215# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
216# sources. Doxygen will then generate output that is tailored for
217# VHDL.
218
219OPTIMIZE_OUTPUT_VHDL = NO
220
221# Doxygen selects the parser to use depending on the extension of the files it
222# parses. With this tag you can assign which parser to use for a given extension.
223# Doxygen has a built-in mapping, but you can override or extend it using this
224# tag. The format is ext=language, where ext is a file extension, and language
225# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
226# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
227# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
228# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
229# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
230
231EXTENSION_MAPPING =
232
233# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
234# to include (a tag file for) the STL sources as input, then you should
235# set this tag to YES in order to let doxygen match functions declarations and
236# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
237# func(std::string) {}). This also makes the inheritance and collaboration
238# diagrams that involve STL classes more complete and accurate.
239
240BUILTIN_STL_SUPPORT = NO
241
242# If you use Microsoft's C++/CLI language, you should set this option to YES to
243# enable parsing support.
244
245CPP_CLI_SUPPORT = NO
246
247# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
248# Doxygen will parse them like normal C++ but will assume all classes use public
249# instead of private inheritance when no explicit protection keyword is present.
250
251SIP_SUPPORT = NO
252
253# For Microsoft's IDL there are propget and propput attributes to indicate getter
254# and setter methods for a property. Setting this option to YES (the default)
255# will make doxygen replace the get and set methods by a property in the
256# documentation. This will only work if the methods are indeed getting or
257# setting a simple type. If this is not the case, or you want to show the
258# methods anyway, you should set this option to NO.
259
260IDL_PROPERTY_SUPPORT = YES
261
262# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
263# tag is set to YES, then doxygen will reuse the documentation of the first
264# member in the group (if any) for the other members of the group. By default
265# all members of a group must be documented explicitly.
266
267DISTRIBUTE_GROUP_DOC = NO
268
269# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
270# the same type (for instance a group of public functions) to be put as a
271# subgroup of that type (e.g. under the Public Functions section). Set it to
272# NO to prevent subgrouping. Alternatively, this can be done per class using
273# the \nosubgrouping command.
274
275SUBGROUPING = YES
276
277# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
278# is documented as struct, union, or enum with the name of the typedef. So
279# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
280# with name TypeT. When disabled the typedef will appear as a member of a file,
281# namespace, or class. And the struct will be named TypeS. This can typically
282# be useful for C code in case the coding convention dictates that all compound
283# types are typedef'ed and only the typedef is referenced, never the tag name.
284
285TYPEDEF_HIDES_STRUCT = NO
286
287# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
288# determine which symbols to keep in memory and which to flush to disk.
289# When the cache is full, less often used symbols will be written to disk.
290# For small to medium size projects (<1000 input files) the default value is
291# probably good enough. For larger projects a too small cache size can cause
292# doxygen to be busy swapping symbols to and from disk most of the time
293# causing a significant performance penalty.
294# If the system has enough physical memory increasing the cache will improve the
295# performance by keeping more symbols in memory. Note that the value works on
296# a logarithmic scale so increasing the size by one will roughly double the
297# memory usage. The cache size is given by this formula:
298# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
299# corresponding to a cache size of 2^16 = 65536 symbols
300
301SYMBOL_CACHE_SIZE = 0
302
303#---------------------------------------------------------------------------
304# Build related configuration options
305#---------------------------------------------------------------------------
306
307# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
308# documentation are documented, even if no documentation was available.
309# Private class members and static file members will be hidden unless
310# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
311
312EXTRACT_ALL = NO
313
314# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
315# will be included in the documentation.
316
317EXTRACT_PRIVATE = NO
318
319# If the EXTRACT_STATIC tag is set to YES all static members of a file
320# will be included in the documentation.
321
322EXTRACT_STATIC = YES
323
324# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
325# defined locally in source files will be included in the documentation.
326# If set to NO only classes defined in header files are included.
327
328EXTRACT_LOCAL_CLASSES = NO
329
330# This flag is only useful for Objective-C code. When set to YES local
331# methods, which are defined in the implementation section but not in
332# the interface are included in the documentation.
333# If set to NO (the default) only methods in the interface are included.
334
335EXTRACT_LOCAL_METHODS = NO
336
337# If this flag is set to YES, the members of anonymous namespaces will be
338# extracted and appear in the documentation as a namespace called
339# 'anonymous_namespace{file}', where file will be replaced with the base
340# name of the file that contains the anonymous namespace. By default
341# anonymous namespaces are hidden.
342
343EXTRACT_ANON_NSPACES = NO
344
345# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
346# undocumented members of documented classes, files or namespaces.
347# If set to NO (the default) these members will be included in the
348# various overviews, but no documentation section is generated.
349# This option has no effect if EXTRACT_ALL is enabled.
350
351HIDE_UNDOC_MEMBERS = NO
352
353# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
354# undocumented classes that are normally visible in the class hierarchy.
355# If set to NO (the default) these classes will be included in the various
356# overviews. This option has no effect if EXTRACT_ALL is enabled.
357
358HIDE_UNDOC_CLASSES = NO
359
360# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
361# friend (class|struct|union) declarations.
362# If set to NO (the default) these declarations will be included in the
363# documentation.
364
365HIDE_FRIEND_COMPOUNDS = NO
366
367# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
368# documentation blocks found inside the body of a function.
369# If set to NO (the default) these blocks will be appended to the
370# function's detailed documentation block.
371
372HIDE_IN_BODY_DOCS = NO
373
374# The INTERNAL_DOCS tag determines if documentation
375# that is typed after a \internal command is included. If the tag is set
376# to NO (the default) then the documentation will be excluded.
377# Set it to YES to include the internal documentation.
378
379INTERNAL_DOCS = NO
380
381# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
382# file names in lower-case letters. If set to YES upper-case letters are also
383# allowed. This is useful if you have classes or files whose names only differ
384# in case and if your file system supports case sensitive file names. Windows
385# and Mac users are advised to set this option to NO.
386
387CASE_SENSE_NAMES = YES
388
389# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
390# will show members with their full class and namespace scopes in the
391# documentation. If set to YES the scope will be hidden.
392
393HIDE_SCOPE_NAMES = NO
394
395# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
396# will put a list of the files that are included by a file in the documentation
397# of that file.
398
399SHOW_INCLUDE_FILES = NO
400
401# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
402# will list include files with double quotes in the documentation
403# rather than with sharp brackets.
404
405FORCE_LOCAL_INCLUDES = NO
406
407# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
408# is inserted in the documentation for inline members.
409
410INLINE_INFO = YES
411
412# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
413# will sort the (detailed) documentation of file and class members
414# alphabetically by member name. If set to NO the members will appear in
415# declaration order.
416
417SORT_MEMBER_DOCS = NO
418
419# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
420# brief documentation of file, namespace and class members alphabetically
421# by member name. If set to NO (the default) the members will appear in
422# declaration order.
423
424SORT_BRIEF_DOCS = NO
425
426# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
427# will sort the (brief and detailed) documentation of class members so that
428# constructors and destructors are listed first. If set to NO (the default)
429# the constructors will appear in the respective orders defined by
430# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
431# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
432# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
433
434SORT_MEMBERS_CTORS_1ST = NO
435
436# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
437# hierarchy of group names into alphabetical order. If set to NO (the default)
438# the group names will appear in their defined order.
439
440SORT_GROUP_NAMES = NO
441
442# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
443# sorted by fully-qualified names, including namespaces. If set to
444# NO (the default), the class list will be sorted only by class name,
445# not including the namespace part.
446# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
447# Note: This option applies only to the class list, not to the
448# alphabetical list.
449
450SORT_BY_SCOPE_NAME = NO
451
452# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
453# match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
454# will still accept a match between prototype and implementation in such cases.
455
456STRICT_PROTO_MATCHING = NO
457
458# The GENERATE_TODOLIST tag can be used to enable (YES) or
459# disable (NO) the todo list. This list is created by putting \todo
460# commands in the documentation.
461
462GENERATE_TODOLIST = YES
463
464# The GENERATE_TESTLIST tag can be used to enable (YES) or
465# disable (NO) the test list. This list is created by putting \test
466# commands in the documentation.
467
468GENERATE_TESTLIST = YES
469
470# The GENERATE_BUGLIST tag can be used to enable (YES) or
471# disable (NO) the bug list. This list is created by putting \bug
472# commands in the documentation.
473
474GENERATE_BUGLIST = YES
475
476# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
477# disable (NO) the deprecated list. This list is created by putting
478# \deprecated commands in the documentation.
479
480GENERATE_DEPRECATEDLIST= YES
481
482# The ENABLED_SECTIONS tag can be used to enable conditional
483# documentation sections, marked by \if sectionname ... \endif.
484
485ENABLED_SECTIONS =
486
487# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
488# the initial value of a variable or macro consists of for it to appear in
489# the documentation. If the initializer consists of more lines than specified
490# here it will be hidden. Use a value of 0 to hide initializers completely.
491# The appearance of the initializer of individual variables and macros in the
492# documentation can be controlled using \showinitializer or \hideinitializer
493# command in the documentation regardless of this setting.
494
495MAX_INITIALIZER_LINES = 30
496
497# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
498# at the bottom of the documentation of classes and structs. If set to YES the
499# list will mention the files that were used to generate the documentation.
500
501SHOW_USED_FILES = NO
502
503# If the sources in your project are distributed over multiple directories
504# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
505# in the documentation. The default is NO.
506
507SHOW_DIRECTORIES = NO
508
509# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
510# This will remove the Files entry from the Quick Index and from the
511# Folder Tree View (if specified). The default is YES.
512
513SHOW_FILES = YES
514
515# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
516# Namespaces page.
517# This will remove the Namespaces entry from the Quick Index
518# and from the Folder Tree View (if specified). The default is YES.
519
520SHOW_NAMESPACES = YES
521
522# The FILE_VERSION_FILTER tag can be used to specify a program or script that
523# doxygen should invoke to get the current version for each file (typically from
524# the version control system). Doxygen will invoke the program by executing (via
525# popen()) the command <command> <input-file>, where <command> is the value of
526# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
527# provided by doxygen. Whatever the program writes to standard output
528# is used as the file version. See the manual for examples.
529
530FILE_VERSION_FILTER =
531
532# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
533# by doxygen. The layout file controls the global structure of the generated
534# output files in an output format independent way. The create the layout file
535# that represents doxygen's defaults, run doxygen with the -l option.
536# You can optionally specify a file name after the option, if omitted
537# DoxygenLayout.xml will be used as the name of the layout file.
538
539LAYOUT_FILE =
540
541#---------------------------------------------------------------------------
542# configuration options related to warning and progress messages
543#---------------------------------------------------------------------------
544
545# The QUIET tag can be used to turn on/off the messages that are generated
546# by doxygen. Possible values are YES and NO. If left blank NO is used.
547
548QUIET = NO
549
550# The WARNINGS tag can be used to turn on/off the warning messages that are
551# generated by doxygen. Possible values are YES and NO. If left blank
552# NO is used.
553
554WARNINGS = YES
555
556# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
557# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
558# automatically be disabled.
559
560WARN_IF_UNDOCUMENTED = YES
561
562# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
563# potential errors in the documentation, such as not documenting some
564# parameters in a documented function, or documenting parameters that
565# don't exist or using markup commands wrongly.
566
567WARN_IF_DOC_ERROR = YES
568
569# The WARN_NO_PARAMDOC option can be enabled to get warnings for
570# functions that are documented, but have no documentation for their parameters
571# or return value. If set to NO (the default) doxygen will only warn about
572# wrong or incomplete parameter documentation, but not about the absence of
573# documentation.
574
575WARN_NO_PARAMDOC = YES
576
577# The WARN_FORMAT tag determines the format of the warning messages that
578# doxygen can produce. The string should contain the $file, $line, and $text
579# tags, which will be replaced by the file and line number from which the
580# warning originated and the warning text. Optionally the format may contain
581# $version, which will be replaced by the version of the file (if it could
582# be obtained via FILE_VERSION_FILTER)
583
584WARN_FORMAT = "$file:$line: $text"
585
586# The WARN_LOGFILE tag can be used to specify a file to which warning
587# and error messages should be written. If left blank the output is written
588# to stderr.
589
590WARN_LOGFILE =
591
592#---------------------------------------------------------------------------
593# configuration options related to the input files
594#---------------------------------------------------------------------------
595
596# The INPUT tag can be used to specify the files and/or directories that contain
597# documented source files. You may enter file names like "myfile.cpp" or
598# directories like "/usr/src/myproject". Separate the files or directories
599# with spaces.
600
601INPUT = @CMAKE_SOURCE_DIR@/lib
602
603# This tag can be used to specify the character encoding of the source files
604# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
605# also the default input encoding. Doxygen uses libiconv (or the iconv built
606# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
607# the list of possible encodings.
608
609INPUT_ENCODING = UTF-8
610
611# If the value of the INPUT tag contains directories, you can use the
612# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
613# and *.h) to filter out the source-files in the directories. If left
614# blank the following patterns are tested:
615# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
616# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
617# *.f90 *.f *.for *.vhd *.vhdl
618
619FILE_PATTERNS = *.c \
620 *.h \
621 *.x
622
623# The RECURSIVE tag can be used to turn specify whether or not subdirectories
624# should be searched for input files as well. Possible values are YES and NO.
625# If left blank NO is used.
626
627RECURSIVE = YES
628
629# The EXCLUDE tag can be used to specify files and/or directories that should
630# excluded from the INPUT source files. This way you can easily exclude a
631# subdirectory from a directory tree whose root is specified with the INPUT tag.
632
633EXCLUDE =
634
635# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
636# directories that are symbolic links (a Unix file system feature) are excluded
637# from the input.
638
639EXCLUDE_SYMLINKS = NO
640
641# If the value of the INPUT tag contains directories, you can use the
642# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
643# certain files from those directories. Note that the wildcards are matched
644# against the file with absolute path, so to exclude all test directories
645# for example use the pattern */test/*
646
647EXCLUDE_PATTERNS =
648
649# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
650# (namespaces, classes, functions, etc.) that should be excluded from the
651# output. The symbol name can be a fully qualified name, a word, or if the
652# wildcard * is used, a substring. Examples: ANamespace, AClass,
653# AClass::ANamespace, ANamespace::*Test
654
655EXCLUDE_SYMBOLS =
656
657# The EXAMPLE_PATH tag can be used to specify one or more files or
658# directories that contain example code fragments that are included (see
659# the \include command).
660
661EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/examples
662
663# If the value of the EXAMPLE_PATH tag contains directories, you can use the
664# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
665# and *.h) to filter out the source-files in the directories. If left
666# blank all files are included.
667
668EXAMPLE_PATTERNS = *.c,*.h,*.x
669
670# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
671# searched for input files to be used with the \include or \dontinclude
672# commands irrespective of the value of the RECURSIVE tag.
673# Possible values are YES and NO. If left blank NO is used.
674
675EXAMPLE_RECURSIVE = NO
676
677# The IMAGE_PATH tag can be used to specify one or more files or
678# directories that contain image that are included in the documentation (see
679# the \image command).
680
681IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/img
682
683# The INPUT_FILTER tag can be used to specify a program that doxygen should
684# invoke to filter for each input file. Doxygen will invoke the filter program
685# by executing (via popen()) the command <filter> <input-file>, where <filter>
686# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
687# input file. Doxygen will then use the output that the filter program writes
688# to standard output.
689# If FILTER_PATTERNS is specified, this tag will be
690# ignored.
691
692INPUT_FILTER =
693
694# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
695# basis.
696# Doxygen will compare the file name with each pattern and apply the
697# filter if there is a match.
698# The filters are a list of the form:
699# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
700# info on how filters are used. If FILTER_PATTERNS is empty or if
701# non of the patterns match the file name, INPUT_FILTER is applied.
702
703FILTER_PATTERNS =
704
705# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
706# INPUT_FILTER) will be used to filter the input files when producing source
707# files to browse (i.e. when SOURCE_BROWSER is set to YES).
708
709FILTER_SOURCE_FILES = NO
710
711# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
712# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
713# and it is also possible to disable source filtering for a specific pattern
714# using *.ext= (so without naming a filter). This option only has effect when
715# FILTER_SOURCE_FILES is enabled.
716
717FILTER_SOURCE_PATTERNS =
718
719#---------------------------------------------------------------------------
720# configuration options related to source browsing
721#---------------------------------------------------------------------------
722
723# If the SOURCE_BROWSER tag is set to YES then a list of source files will
724# be generated. Documented entities will be cross-referenced with these sources.
725# Note: To get rid of all source code in the generated output, make sure also
726# VERBATIM_HEADERS is set to NO.
727
728SOURCE_BROWSER = NO
729
730# Setting the INLINE_SOURCES tag to YES will include the body
731# of functions and classes directly in the documentation.
732
733INLINE_SOURCES = NO
734
735# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
736# doxygen to hide any special comment blocks from generated source code
737# fragments. Normal C and C++ comments will always remain visible.
738
739STRIP_CODE_COMMENTS = YES
740
741# If the REFERENCED_BY_RELATION tag is set to YES
742# then for each documented function all documented
743# functions referencing it will be listed.
744
745REFERENCED_BY_RELATION = YES
746
747# If the REFERENCES_RELATION tag is set to YES
748# then for each documented function all documented entities
749# called/used by that function will be listed.
750
751REFERENCES_RELATION = YES
752
753# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
754# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
755# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
756# link to the source code.
757# Otherwise they will link to the documentation.
758
759REFERENCES_LINK_SOURCE = YES
760
761# If the USE_HTAGS tag is set to YES then the references to source code
762# will point to the HTML generated by the htags(1) tool instead of doxygen
763# built-in source browser. The htags tool is part of GNU's global source
764# tagging system (see http://www.gnu.org/software/global/global.html). You
765# will need version 4.8.6 or higher.
766
767USE_HTAGS = NO
768
769# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
770# will generate a verbatim copy of the header file for each class for
771# which an include is specified. Set to NO to disable this.
772
773VERBATIM_HEADERS = NO
774
775#---------------------------------------------------------------------------
776# configuration options related to the alphabetical class index
777#---------------------------------------------------------------------------
778
779# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
780# of all compounds will be generated. Enable this if the project
781# contains a lot of classes, structs, unions or interfaces.
782
783ALPHABETICAL_INDEX = YES
784
785# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
786# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
787# in which this list will be split (can be a number in the range [1..20])
788
789COLS_IN_ALPHA_INDEX = 2
790
791# In case all classes in a project start with a common prefix, all
792# classes will be put under the same header in the alphabetical index.
793# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
794# should be ignored while generating the index headers.
795
796IGNORE_PREFIX = eobj_ \
797 _eobj_ \
798 Eobj_ \
799 _Eobj_ \
800 EOBJ_ \
801 _EOBJ_
802
803#---------------------------------------------------------------------------
804# configuration options related to the HTML output
805#---------------------------------------------------------------------------
806
807# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
808# generate HTML output.
809
810GENERATE_HTML = YES
811
812# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
813# If a relative path is entered the value of OUTPUT_DIRECTORY will be
814# put in front of it. If left blank `html' will be used as the default path.
815
816HTML_OUTPUT = html
817
818# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
819# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
820# doxygen will generate files with .html extension.
821
822HTML_FILE_EXTENSION = .html
823
824# The HTML_HEADER tag can be used to specify a personal HTML header for
825# each generated HTML page. If it is left blank doxygen will generate a
826# standard header.
827
828HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/head.html
829
830# The HTML_FOOTER tag can be used to specify a personal HTML footer for
831# each generated HTML page. If it is left blank doxygen will generate a
832# standard footer.
833
834HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/foot.html
835
836# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
837# style sheet that is used by each HTML page. It can be used to
838# fine-tune the look of the HTML output. If the tag is left blank doxygen
839# will generate a default style sheet. Note that doxygen will try to copy
840# the style sheet file to the HTML output directory, so don't put your own
841# stylesheet in the HTML output directory as well, or it will be erased!
842
843HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/e.css
844
845# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
846# Doxygen will adjust the colors in the stylesheet and background images
847# according to this color. Hue is specified as an angle on a colorwheel,
848# see http://en.wikipedia.org/wiki/Hue for more information.
849# For instance the value 0 represents red, 60 is yellow, 120 is green,
850# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
851# The allowed range is 0 to 359.
852
853HTML_COLORSTYLE_HUE = 220
854
855# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
856# the colors in the HTML output. For a value of 0 the output will use
857# grayscales only. A value of 255 will produce the most vivid colors.
858
859HTML_COLORSTYLE_SAT = 100
860
861# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
862# the luminance component of the colors in the HTML output. Values below
863# 100 gradually make the output lighter, whereas values above 100 make
864# the output darker. The value divided by 100 is the actual gamma applied,
865# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
866# and 100 does not change the gamma.
867
868HTML_COLORSTYLE_GAMMA = 80
869
870# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
871# page will contain the date and time when the page was generated. Setting
872# this to NO can help when comparing the output of multiple runs.
873
874HTML_TIMESTAMP = YES
875
876# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
877# files or namespaces will be aligned in HTML using tables. If set to
878# NO a bullet list will be used.
879
880HTML_ALIGN_MEMBERS = YES
881
882# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
883# documentation will contain sections that can be hidden and shown after the
884# page has loaded. For this to work a browser that supports
885# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
886# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
887
888HTML_DYNAMIC_SECTIONS = YES
889
890# If the GENERATE_DOCSET tag is set to YES, additional index files
891# will be generated that can be used as input for Apple's Xcode 3
892# integrated development environment, introduced with OSX 10.5 (Leopard).
893# To create a documentation set, doxygen will generate a Makefile in the
894# HTML output directory. Running make will produce the docset in that
895# directory and running "make install" will install the docset in
896# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
897# it at startup.
898# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
899# for more information.
900
901GENERATE_DOCSET = YES
902
903# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
904# feed. A documentation feed provides an umbrella under which multiple
905# documentation sets from a single provider (such as a company or product suite)
906# can be grouped.
907
908DOCSET_FEEDNAME = "Doxygen generated docs"
909
910# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
911# should uniquely identify the documentation set bundle. This should be a
912# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
913# will append .docset to the name.
914
915DOCSET_BUNDLE_ID = org.enlightenment.Eobj
916
917# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
918# the documentation publisher. This should be a reverse domain-name style
919# string, e.g. com.mycompany.MyDocSet.documentation.
920
921DOCSET_PUBLISHER_ID = org.enlightenment.Eobj
922
923# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
924
925DOCSET_PUBLISHER_NAME = Enlightenment
926
927# If the GENERATE_HTMLHELP tag is set to YES, additional index files
928# will be generated that can be used as input for tools like the
929# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
930# of the generated HTML documentation.
931
932GENERATE_HTMLHELP = YES
933
934# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
935# be used to specify the file name of the resulting .chm file. You
936# can add a path in front of the file if the result should not be
937# written to the html output directory.
938
939CHM_FILE =
940
941# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
942# be used to specify the location (absolute path including file name) of
943# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
944# the HTML help compiler on the generated index.hhp.
945
946HHC_LOCATION =
947
948# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
949# controls if a separate .chi index file is generated (YES) or that
950# it should be included in the master .chm file (NO).
951
952GENERATE_CHI = NO
953
954# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
955# is used to encode HtmlHelp index (hhk), content (hhc) and project file
956# content.
957
958CHM_INDEX_ENCODING =
959
960# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
961# controls whether a binary table of contents is generated (YES) or a
962# normal table of contents (NO) in the .chm file.
963
964BINARY_TOC = NO
965
966# The TOC_EXPAND flag can be set to YES to add extra items for group members
967# to the contents of the HTML help documentation and to the tree view.
968
969TOC_EXPAND = NO
970
971# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
972# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
973# that can be used as input for Qt's qhelpgenerator to generate a
974# Qt Compressed Help (.qch) of the generated HTML documentation.
975
976GENERATE_QHP = NO
977
978# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
979# be used to specify the file name of the resulting .qch file.
980# The path specified is relative to the HTML output folder.
981
982QCH_FILE =
983
984# The QHP_NAMESPACE tag specifies the namespace to use when generating
985# Qt Help Project output. For more information please see
986# http://doc.trolltech.com/qthelpproject.html#namespace
987
988QHP_NAMESPACE = org.enlightenment.Eobj
989
990# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
991# Qt Help Project output. For more information please see
992# http://doc.trolltech.com/qthelpproject.html#virtual-folders
993
994QHP_VIRTUAL_FOLDER = doc
995
996# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
997# add. For more information please see
998# http://doc.trolltech.com/qthelpproject.html#custom-filters
999
1000QHP_CUST_FILTER_NAME =
1001
1002# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1003# custom filter to add. For more information please see
1004# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1005# Qt Help Project / Custom Filters</a>.
1006
1007QHP_CUST_FILTER_ATTRS =
1008
1009# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1010# project's
1011# filter section matches.
1012# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1013# Qt Help Project / Filter Attributes</a>.
1014
1015QHP_SECT_FILTER_ATTRS =
1016
1017# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1018# be used to specify the location of Qt's qhelpgenerator.
1019# If non-empty doxygen will try to run qhelpgenerator on the generated
1020# .qhp file.
1021
1022QHG_LOCATION =
1023
1024# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1025# will be generated, which together with the HTML files, form an Eclipse help
1026# plugin. To install this plugin and make it available under the help contents
1027# menu in Eclipse, the contents of the directory containing the HTML and XML
1028# files needs to be copied into the plugins directory of eclipse. The name of
1029# the directory within the plugins directory should be the same as
1030# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1031# the help appears.
1032
1033GENERATE_ECLIPSEHELP = NO
1034
1035# A unique identifier for the eclipse help plugin. When installing the plugin
1036# the directory name containing the HTML and XML files should also have
1037# this name.
1038
1039ECLIPSE_DOC_ID = org.enlightenment.Eobj
1040
1041# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1042# top of each HTML page. The value NO (the default) enables the index and
1043# the value YES disables it.
1044
1045DISABLE_INDEX = YES
1046
1047# This tag can be used to set the number of enum values (range [0,1..20])
1048# that doxygen will group on one line in the generated HTML documentation.
1049# Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
1050
1051ENUM_VALUES_PER_LINE = 1
1052
1053# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1054# structure should be generated to display hierarchical information.
1055# If the tag value is set to YES, a side panel will be generated
1056# containing a tree-like index structure (just like the one that
1057# is generated for HTML Help). For this to work a browser that supports
1058# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1059# Windows users are probably better off using the HTML help feature.
1060
1061GENERATE_TREEVIEW = NO
1062
1063# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1064# and Class Hierarchy pages using a tree view instead of an ordered list.
1065
1066USE_INLINE_TREES = NO
1067
1068# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1069# used to set the initial width (in pixels) of the frame in which the tree
1070# is shown.
1071
1072TREEVIEW_WIDTH = 250
1073
1074# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1075# links to external symbols imported via tag files in a separate window.
1076
1077EXT_LINKS_IN_WINDOW = NO
1078
1079# Use this tag to change the font size of Latex formulas included
1080# as images in the HTML documentation. The default is 10. Note that
1081# when you change the font size after a successful doxygen run you need
1082# to manually remove any form_*.png images from the HTML output directory
1083# to force them to be regenerated.
1084
1085FORMULA_FONTSIZE = 10
1086
1087# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1088# generated for formulas are transparent PNGs. Transparent PNGs are
1089# not supported properly for IE 6.0, but are supported on all modern browsers.
1090# Note that when changing this option you need to delete any form_*.png files
1091# in the HTML output before the changes have effect.
1092
1093FORMULA_TRANSPARENT = YES
1094
1095# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1096# (see http://www.mathjax.org) which uses client side Javascript for the
1097# rendering instead of using prerendered bitmaps. Use this if you do not
1098# have LaTeX installed or if you want to formulas look prettier in the HTML
1099# output. When enabled you also need to install MathJax separately and
1100# configure the path to it using the MATHJAX_RELPATH option.
1101
1102USE_MATHJAX = NO
1103
1104# When MathJax is enabled you need to specify the location relative to the
1105# HTML output directory using the MATHJAX_RELPATH option. The destination
1106# directory should contain the MathJax.js script. For instance, if the mathjax
1107# directory is located at the same level as the HTML output directory, then
1108# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
1109# MathJax, but it is strongly recommended to install a local copy of MathJax
1110# before deployment.
1111
1112MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1113
1114# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1115# for the HTML output. The underlying search engine uses javascript
1116# and DHTML and should work on any modern browser. Note that when using
1117# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1118# (GENERATE_DOCSET) there is already a search function so this one should
1119# typically be disabled. For large projects the javascript based search engine
1120# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1121
1122SEARCHENGINE = NO
1123
1124# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1125# implemented using a PHP enabled web server instead of at the web client
1126# using Javascript. Doxygen will generate the search PHP script and index
1127# file to put on the web server. The advantage of the server
1128# based approach is that it scales better to large projects and allows
1129# full text search. The disadvantages are that it is more difficult to setup
1130# and does not have live searching capabilities.
1131
1132SERVER_BASED_SEARCH = NO
1133
1134#---------------------------------------------------------------------------
1135# configuration options related to the LaTeX output
1136#---------------------------------------------------------------------------
1137
1138# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1139# generate Latex output.
1140
1141GENERATE_LATEX = YES
1142
1143# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1144# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1145# put in front of it. If left blank `latex' will be used as the default path.
1146
1147LATEX_OUTPUT = latex
1148
1149# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1150# invoked. If left blank `latex' will be used as the default command name.
1151# Note that when enabling USE_PDFLATEX this option is only used for
1152# generating bitmaps for formulas in the HTML output, but not in the
1153# Makefile that is written to the output directory.
1154
1155LATEX_CMD_NAME = latex
1156
1157# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1158# generate index for LaTeX. If left blank `makeindex' will be used as the
1159# default command name.
1160
1161MAKEINDEX_CMD_NAME = makeindex
1162
1163# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1164# LaTeX documents. This may be useful for small projects and may help to
1165# save some trees in general.
1166
1167COMPACT_LATEX = NO
1168
1169# The PAPER_TYPE tag can be used to set the paper type that is used
1170# by the printer. Possible values are: a4, letter, legal and
1171# executive. If left blank a4wide will be used.
1172
1173PAPER_TYPE = a4wide
1174
1175# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1176# packages that should be included in the LaTeX output.
1177
1178EXTRA_PACKAGES =
1179
1180# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1181# the generated latex document. The header should contain everything until
1182# the first chapter. If it is left blank doxygen will generate a
1183# standard header. Notice: only use this tag if you know what you are doing!
1184
1185LATEX_HEADER =
1186
1187# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1188# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1189# contain links (just like the HTML output) instead of page references
1190# This makes the output suitable for online browsing using a pdf viewer.
1191
1192PDF_HYPERLINKS = YES
1193
1194# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1195# plain latex in the generated Makefile. Set this option to YES to get a
1196# higher quality PDF documentation.
1197
1198USE_PDFLATEX = YES
1199
1200# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1201# command to the generated LaTeX files. This will instruct LaTeX to keep
1202# running if errors occur, instead of asking the user for help.
1203# This option is also used when generating formulas in HTML.
1204
1205LATEX_BATCHMODE = NO
1206
1207# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1208# include the index chapters (such as File Index, Compound Index, etc.)
1209# in the output.
1210
1211LATEX_HIDE_INDICES = NO
1212
1213# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1214# source code with syntax highlighting in the LaTeX output.
1215# Note that which sources are shown also depends on other settings
1216# such as SOURCE_BROWSER.
1217
1218LATEX_SOURCE_CODE = NO
1219
1220#---------------------------------------------------------------------------
1221# configuration options related to the RTF output
1222#---------------------------------------------------------------------------
1223
1224# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1225# The RTF output is optimized for Word 97 and may not look very pretty with
1226# other RTF readers or editors.
1227
1228GENERATE_RTF = NO
1229
1230# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1231# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1232# put in front of it. If left blank `rtf' will be used as the default path.
1233
1234RTF_OUTPUT = rtf
1235
1236# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1237# RTF documents. This may be useful for small projects and may help to
1238# save some trees in general.
1239
1240COMPACT_RTF = NO
1241
1242# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1243# will contain hyperlink fields. The RTF file will
1244# contain links (just like the HTML output) instead of page references.
1245# This makes the output suitable for online browsing using WORD or other
1246# programs which support those fields.
1247# Note: wordpad (write) and others do not support links.
1248
1249RTF_HYPERLINKS = NO
1250
1251# Load stylesheet definitions from file. Syntax is similar to doxygen's
1252# config file, i.e. a series of assignments. You only have to provide
1253# replacements, missing definitions are set to their default value.
1254
1255RTF_STYLESHEET_FILE =
1256
1257# Set optional variables used in the generation of an rtf document.
1258# Syntax is similar to doxygen's config file.
1259
1260RTF_EXTENSIONS_FILE =
1261
1262#---------------------------------------------------------------------------
1263# configuration options related to the man page output
1264#---------------------------------------------------------------------------
1265
1266# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1267# generate man pages
1268
1269GENERATE_MAN = YES
1270
1271# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1272# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1273# put in front of it. If left blank `man' will be used as the default path.
1274
1275MAN_OUTPUT = man
1276
1277# The MAN_EXTENSION tag determines the extension that is added to
1278# the generated man pages (default is the subroutine's section .3)
1279
1280MAN_EXTENSION = .3
1281
1282# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1283# then it will generate one additional man file for each entity
1284# documented in the real man page(s). These additional files
1285# only source the real man page, but without them the man command
1286# would be unable to find the correct page. The default is NO.
1287
1288MAN_LINKS = YES
1289
1290#---------------------------------------------------------------------------
1291# configuration options related to the XML output
1292#---------------------------------------------------------------------------
1293
1294# If the GENERATE_XML tag is set to YES Doxygen will
1295# generate an XML file that captures the structure of
1296# the code including all documentation.
1297
1298GENERATE_XML = NO
1299
1300# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1301# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1302# put in front of it. If left blank `xml' will be used as the default path.
1303
1304XML_OUTPUT = xml
1305
1306# The XML_SCHEMA tag can be used to specify an XML schema,
1307# which can be used by a validating XML parser to check the
1308# syntax of the XML files.
1309
1310XML_SCHEMA =
1311
1312# The XML_DTD tag can be used to specify an XML DTD,
1313# which can be used by a validating XML parser to check the
1314# syntax of the XML files.
1315
1316XML_DTD =
1317
1318# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1319# dump the program listings (including syntax highlighting
1320# and cross-referencing information) to the XML output. Note that
1321# enabling this will significantly increase the size of the XML output.
1322
1323XML_PROGRAMLISTING = YES
1324
1325#---------------------------------------------------------------------------
1326# configuration options for the AutoGen Definitions output
1327#---------------------------------------------------------------------------
1328
1329# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1330# generate an AutoGen Definitions (see autogen.sf.net) file
1331# that captures the structure of the code including all
1332# documentation. Note that this feature is still experimental
1333# and incomplete at the moment.
1334
1335GENERATE_AUTOGEN_DEF = NO
1336
1337#---------------------------------------------------------------------------
1338# configuration options related to the Perl module output
1339#---------------------------------------------------------------------------
1340
1341# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1342# generate a Perl module file that captures the structure of
1343# the code including all documentation. Note that this
1344# feature is still experimental and incomplete at the
1345# moment.
1346
1347GENERATE_PERLMOD = NO
1348
1349# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1350# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1351# to generate PDF and DVI output from the Perl module output.
1352
1353PERLMOD_LATEX = NO
1354
1355# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1356# nicely formatted so it can be parsed by a human reader.
1357# This is useful
1358# if you want to understand what is going on.
1359# On the other hand, if this
1360# tag is set to NO the size of the Perl module output will be much smaller
1361# and Perl will parse it just the same.
1362
1363PERLMOD_PRETTY = YES
1364
1365# The names of the make variables in the generated doxyrules.make file
1366# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1367# This is useful so different doxyrules.make files included by the same
1368# Makefile don't overwrite each other's variables.
1369
1370PERLMOD_MAKEVAR_PREFIX =
1371
1372#---------------------------------------------------------------------------
1373# Configuration options related to the preprocessor
1374#---------------------------------------------------------------------------
1375
1376# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1377# evaluate all C-preprocessor directives found in the sources and include
1378# files.
1379
1380ENABLE_PREPROCESSING = YES
1381
1382# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1383# names in the source code. If set to NO (the default) only conditional
1384# compilation will be performed. Macro expansion can be done in a controlled
1385# way by setting EXPAND_ONLY_PREDEF to YES.
1386
1387MACRO_EXPANSION = YES
1388
1389# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1390# then the macro expansion is limited to the macros specified with the
1391# PREDEFINED and EXPAND_AS_DEFINED tags.
1392
1393EXPAND_ONLY_PREDEF = YES
1394
1395# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1396# in the INCLUDE_PATH (see below) will be search if a #include is found.
1397
1398SEARCH_INCLUDES = NO
1399
1400# The INCLUDE_PATH tag can be used to specify one or more directories that
1401# contain include files that are not input files but should be processed by
1402# the preprocessor.
1403
1404INCLUDE_PATH =
1405
1406# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1407# patterns (like *.h and *.hpp) to filter out the header-files in the
1408# directories. If left blank, the patterns specified with FILE_PATTERNS will
1409# be used.
1410
1411INCLUDE_FILE_PATTERNS =
1412
1413# The PREDEFINED tag can be used to specify one or more macro names that
1414# are defined before the preprocessor is started (similar to the -D option of
1415# gcc). The argument of the tag is a list of macros of the form: name
1416# or name=definition (no spaces). If the definition and the = are
1417# omitted =1 is assumed. To prevent a macro definition from being
1418# undefined via #undef or recursively expanded use the := operator
1419# instead of the = operator.
1420
1421PREDEFINED = EOBJ_MAGIC_DEBUG \
1422 __UNUSED__= \
1423 EOBJ_ARG_NONNULL()= \
1424 EOBJ_MALLOC= \
1425 EOBJ_WARN_UNUSED_RESULT= \
1426 EAPI= \
1427 EOBJ_PURE= \
1428 EOBJ_CONST=
1429
1430# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1431# this tag can be used to specify a list of macro names that should be expanded.
1432# The macro definition that is found in the sources will be used.
1433# Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
1434
1435EXPAND_AS_DEFINED =
1436
1437# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1438# doxygen's preprocessor will remove all references to function-like macros
1439# that are alone on a line, have an all uppercase name, and do not end with a
1440# semicolon, because these will confuse the parser if not removed.
1441
1442SKIP_FUNCTION_MACROS = YES
1443
1444#---------------------------------------------------------------------------
1445# Configuration::additions related to external references
1446#---------------------------------------------------------------------------
1447
1448# The TAGFILES option can be used to specify one or more tagfiles.
1449# Optionally an initial location of the external documentation
1450# can be added for each tagfile. The format of a tag file without
1451# this location is as follows:
1452#
1453# TAGFILES = file1 file2 ...
1454# Adding location for the tag files is done as follows:
1455#
1456# TAGFILES = file1=loc1 "file2 = loc2" ...
1457# where "loc1" and "loc2" can be relative or absolute paths or
1458# URLs. If a location is present for each tag, the installdox tool
1459# does not have to be run to correct the links.
1460# Note that each tag file must have a unique name
1461# (where the name does NOT include the path)
1462# If a tag file is not located in the directory in which doxygen
1463# is run, you must also specify the path to the tagfile here.
1464
1465TAGFILES =
1466
1467# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1468# a tag file that is based on the input files it reads.
1469
1470GENERATE_TAGFILE =
1471
1472# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1473# in the class index. If set to NO only the inherited external classes
1474# will be listed.
1475
1476ALLEXTERNALS = NO
1477
1478# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1479# in the modules index. If set to NO, only the current project's groups will
1480# be listed.
1481
1482EXTERNAL_GROUPS = YES
1483
1484# The PERL_PATH should be the absolute path and name of the perl script
1485# interpreter (i.e. the result of `which perl').
1486
1487PERL_PATH = /usr/bin/perl
1488
1489#---------------------------------------------------------------------------
1490# Configuration options related to the dot tool
1491#---------------------------------------------------------------------------
1492
1493# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1494# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1495# or super classes. Setting the tag to NO turns the diagrams off. Note that
1496# this option also works with HAVE_DOT disabled, but it is recommended to
1497# install and use dot, since it yields more powerful graphs.
1498
1499CLASS_DIAGRAMS = NO
1500
1501# You can define message sequence charts within doxygen comments using the \msc
1502# command. Doxygen will then run the mscgen tool (see
1503# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1504# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1505# the mscgen tool resides. If left empty the tool is assumed to be found in the
1506# default search path.
1507
1508MSCGEN_PATH =
1509
1510# If set to YES, the inheritance and collaboration graphs will hide
1511# inheritance and usage relations if the target is undocumented
1512# or is not a class.
1513
1514HIDE_UNDOC_RELATIONS = YES
1515
1516# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1517# available from the path. This tool is part of Graphviz, a graph visualization
1518# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1519# have no effect if this option is set to NO (the default)
1520
1521HAVE_DOT = NO
1522
1523# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1524# allowed to run in parallel. When set to 0 (the default) doxygen will
1525# base this on the number of processors available in the system. You can set it
1526# explicitly to a value larger than 0 to get control over the balance
1527# between CPU load and processing speed.
1528
1529DOT_NUM_THREADS = 0
1530
1531# By default doxygen will write a font called Helvetica to the output
1532# directory and reference it in all dot files that doxygen generates.
1533# When you want a differently looking font you can specify the font name
1534# using DOT_FONTNAME. You need to make sure dot is able to find the font,
1535# which can be done by putting it in a standard location or by setting the
1536# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1537# containing the font.
1538
1539DOT_FONTNAME = Helvetica
1540
1541# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1542# The default size is 10pt.
1543
1544DOT_FONTSIZE = 10
1545
1546# By default doxygen will tell dot to use the output directory to look for the
1547# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1548# different font using DOT_FONTNAME you can set the path where dot
1549# can find it using this tag.
1550
1551DOT_FONTPATH =
1552
1553# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1554# will generate a graph for each documented class showing the direct and
1555# indirect inheritance relations. Setting this tag to YES will force the
1556# the CLASS_DIAGRAMS tag to NO.
1557
1558CLASS_GRAPH = NO
1559
1560# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1561# will generate a graph for each documented class showing the direct and
1562# indirect implementation dependencies (inheritance, containment, and
1563# class references variables) of the class with other documented classes.
1564
1565COLLABORATION_GRAPH = NO
1566
1567# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1568# will generate a graph for groups, showing the direct groups dependencies
1569
1570GROUP_GRAPHS = YES
1571
1572# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1573# collaboration diagrams in a style similar to the OMG's Unified Modeling
1574# Language.
1575
1576UML_LOOK = NO
1577
1578# If set to YES, the inheritance and collaboration graphs will show the
1579# relations between templates and their instances.
1580
1581TEMPLATE_RELATIONS = NO
1582
1583# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1584# tags are set to YES then doxygen will generate a graph for each documented
1585# file showing the direct and indirect include dependencies of the file with
1586# other documented files.
1587
1588INCLUDE_GRAPH = NO
1589
1590# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1591# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1592# documented header file showing the documented files that directly or
1593# indirectly include this file.
1594
1595INCLUDED_BY_GRAPH = NO
1596
1597# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1598# doxygen will generate a call dependency graph for every global function
1599# or class method. Note that enabling this option will significantly increase
1600# the time of a run. So in most cases it will be better to enable call graphs
1601# for selected functions only using the \callgraph command.
1602
1603CALL_GRAPH = NO
1604
1605# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1606# doxygen will generate a caller dependency graph for every global function
1607# or class method. Note that enabling this option will significantly increase
1608# the time of a run. So in most cases it will be better to enable caller
1609# graphs for selected functions only using the \callergraph command.
1610
1611CALLER_GRAPH = NO
1612
1613# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1614# will generate a graphical hierarchy of all classes instead of a textual one.
1615
1616GRAPHICAL_HIERARCHY = NO
1617
1618# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1619# then doxygen will show the dependencies a directory has on other directories
1620# in a graphical way. The dependency relations are determined by the #include
1621# relations between the files in the directories.
1622
1623DIRECTORY_GRAPH = YES
1624
1625# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1626# generated by dot. Possible values are png, svg, gif or svg.
1627# If left blank png will be used.
1628
1629DOT_IMAGE_FORMAT = png
1630
1631# The tag DOT_PATH can be used to specify the path where the dot tool can be
1632# found. If left blank, it is assumed the dot tool can be found in the path.
1633
1634DOT_PATH =
1635
1636# The DOTFILE_DIRS tag can be used to specify one or more directories that
1637# contain dot files that are included in the documentation (see the
1638# \dotfile command).
1639
1640DOTFILE_DIRS =
1641
1642# The MSCFILE_DIRS tag can be used to specify one or more directories that
1643# contain msc files that are included in the documentation (see the
1644# \mscfile command).
1645
1646MSCFILE_DIRS =
1647
1648# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1649# nodes that will be shown in the graph. If the number of nodes in a graph
1650# becomes larger than this value, doxygen will truncate the graph, which is
1651# visualized by representing a node as a red box. Note that doxygen if the
1652# number of direct children of the root node in a graph is already larger than
1653# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1654# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1655
1656DOT_GRAPH_MAX_NODES = 50
1657
1658# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1659# graphs generated by dot. A depth value of 3 means that only nodes reachable
1660# from the root by following a path via at most 3 edges will be shown. Nodes
1661# that lay further from the root node will be omitted. Note that setting this
1662# option to 1 or 2 may greatly reduce the computation time needed for large
1663# code bases. Also note that the size of a graph can be further restricted by
1664# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1665
1666MAX_DOT_GRAPH_DEPTH = 0
1667
1668# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1669# background. This is disabled by default, because dot on Windows does not
1670# seem to support this out of the box. Warning: Depending on the platform used,
1671# enabling this option may lead to badly anti-aliased labels on the edges of
1672# a graph (i.e. they become hard to read).
1673
1674DOT_TRANSPARENT = YES
1675
1676# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1677# files in one run (i.e. multiple -o and -T options on the command line). This
1678# makes dot run faster, but since only newer versions of dot (>1.8.10)
1679# support this, this feature is disabled by default.
1680
1681DOT_MULTI_TARGETS = NO
1682
1683# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1684# generate a legend page explaining the meaning of the various boxes and
1685# arrows in the dot generated graphs.
1686
1687GENERATE_LEGEND = YES
1688
1689# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1690# remove the intermediate dot files that are used to generate
1691# the various graphs.
1692
1693DOT_CLEANUP = YES
diff --git a/legacy/eobj/doc/e.css b/legacy/eobj/doc/e.css
new file mode 100644
index 0000000000..2dd6b44798
--- /dev/null
+++ b/legacy/eobj/doc/e.css
@@ -0,0 +1,273 @@
1/*
2 Author:
3 Andres Blanc <andresblanc@gmail.com>
4 DaveMDS Andreoli <dave@gurumeditation.it>
5
6 Supported Browsers:
7 ie7, opera9, konqueror4 and firefox3
8
9 Please use a different file for ie6, ie5, etc. hacks.
10*/
11
12
13/* Necessary to place the footer at the bottom of the page */
14html, body {
15 height: 100%;
16 margin: 0px;
17 padding: 0px;
18}
19
20#container {
21 min-height: 100%;
22 height: auto !important;
23 height: 100%;
24 margin: 0 auto -53px;
25}
26
27#footer, #push {
28 height: 53px;
29}
30
31
32* html #container {
33 height: 100%;
34}
35
36/* Prevent floating elements overflowing containers */
37.clear {
38 clear: both;
39 width: 0px;
40 height: 0px;
41}
42
43/* Flexible & centered layout from 750 to 960 pixels */
44.layout {
45 max-width: 960px;
46 min-width: 760px;
47 margin-left: auto;
48 margin-right: auto;
49}
50
51body {
52 /*font-family: Lucida Grande, Helvetica, sans-serif;*/
53 font-family: "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif
54}
55
56/* Prevent design overflowing the viewport in small resolutions */
57#container {
58 padding-right: 17px;
59 padding-left: 17px;
60 background-image: url(head_bg.png);
61 background-repeat: repeat-x;
62}
63
64/****************************/
65/* Top main menu */
66/****************************/
67#header_logo {
68 background-image : url(logo.png);
69 width : 61px;
70}
71
72#header_logo a {
73 position : absolute;
74 border : 0px;
75 background-color : transparent;
76 top : 0px;
77 width : 60px;
78 height : 60px;
79}
80
81#header_menu {
82 background-image : url(header_menu_background.png);
83 font : normal 10pt verdana,'Bitstream Vera Sans',helvetica,arial,sans-serif;
84 text-align : right;
85}
86
87#header_last {
88 background-image : url(header_menu_background_last.png);
89 width : 15px;
90}
91
92td.nav_passive {
93 background : url(header_menu_unselected_background.png) 0 0 no-repeat;
94 height : 63px;
95 font-family : "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
96 font-size : 11px;
97 padding : 20px 10px 20px 10px;
98 vertical-align : middle;
99}
100
101td.nav_active {
102 background : url(header_menu_current_background.png) 0 0 no-repeat;
103 height : 63px;
104 color : #646464;
105 font-family : "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
106 font-size : 11px;
107 font-weight : bold;
108 padding : 20px 10px 20px 10px;
109 vertical-align : middle;
110}
111
112#header_menu a {
113 display : block;
114 text-decoration : none;
115 cursor : pointer;
116 color : #cdcdcd;
117}
118
119
120
121#header {
122 width: 100%;
123 height: 102px;
124}
125
126#header h1 {
127 width: 63px;
128 height: 63px;
129 position: absolute;
130 margin: 0px;
131}
132
133#header h1 span {
134 display: none;
135}
136
137#header h2 {
138 display: none;
139}
140
141/* .menu-container is used to set properties common to .menu and .submenu */
142#header .menu-container {
143}
144
145#header .menu-container ul {
146 list-style-type: none;
147 list-style-position: inside;
148 margin: 0;
149}
150
151#header .menu-container li {
152 display: block;
153 float: right;
154}
155
156#header .menu {
157 height: 63px;
158 display: block;
159 background-image: url(menu_bg.png);
160 background-repeat: repeat-x;
161}
162
163#header .menu ul {
164 height: 100%;
165 display: block;
166 background-image: url(menu_bg_last.png);
167 background-repeat: no-repeat;
168 background-position: top right;
169 padding-right: 17px;
170}
171
172#header .menu li {
173 height: 100%;
174 text-align: center;
175 background-image: url(menu_bg_unsel.png);
176 background-repeat: no-repeat;
177}
178
179#header .menu a {
180 height: 100%;
181 display: block;
182 color: #cdcdcd;
183 text-decoration: none;
184 font-size: 10pt;
185 line-height: 59px;
186 text-align: center;
187 padding: 0px 15px 0px 15px;
188}
189
190#header .menu li:hover {
191 background-image: url(menu_bg_hover.png);
192 background-repeat: no-repeat;
193}
194
195#header .menu li:hover a {
196 color: #FFFFFF;
197}
198
199#header .menu li.current {
200 background-image: url(menu_bg_current.png);
201 background-repeat: no-repeat;
202}
203
204#header .menu li.current a {
205 color: #646464;
206}
207
208
209/* Hide all the submenus but the current */
210#header .submenu ul {
211 display: none;
212}
213
214#header .submenu .current {
215 display: block;
216}
217
218#header .submenu {
219 font: bold 10px verdana,'Bitstream Vera Sans',helvetica,arial,sans-serif;
220 margin-top: 10px;
221}
222
223#header .submenu a {
224 color: #888888;
225 text-decoration: none;
226 font-size: 0.9em;
227 line-height: 15px;
228 padding:0px 5px 0px 5px;
229}
230
231#header .submenu a:hover {
232 color: #444444;
233}
234
235#header .submenu li {
236 border-left: 1px solid #DDDDDD;
237}
238
239#header .submenu li:last-child {
240 border-left: 0;
241}
242
243#header .doxytitle {
244 position: absolute;
245 font-size: 1.8em;
246 font-weight: bold;
247 color: #444444;
248 line-height: 35px;
249}
250
251#header small {
252 font-size: 0.4em;
253}
254
255#footer {
256 background-image: url(foot_bg.png);
257 width: 100%;
258}
259
260#footer table {
261 width: 100%;
262 text-align: center;
263 white-space: nowrap;
264 padding: 5px 30px 5px 30px;
265 font-size: 0.8em;
266 font-family: "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
267 color: #888888;
268}
269
270#footer td.copyright {
271 width: 100%;
272}
273
diff --git a/legacy/eobj/doc/foot.html b/legacy/eobj/doc/foot.html
new file mode 100644
index 0000000000..3a96978280
--- /dev/null
+++ b/legacy/eobj/doc/foot.html
@@ -0,0 +1,20 @@
1
2 <div id="push"></div>
3 </div> <!-- #content -->
4 </div> <!-- .layout -->
5
6 </div> <!-- #container -->
7
8
9 <div id="footer">
10 <table><tr>
11 <td class="poweredby"><img src="doxygen.png"></td>
12 <td>Samsung Electronics is supporting the EFL Documentation Project</td>
13 <td class="copyright">Copyright &copy;$year Enlightenment</td>
14 <td class="generated">Docs generated $datetime</td>
15 </tr></table>
16 </div>
17
18
19</body>
20</html>
diff --git a/legacy/eobj/doc/head.html b/legacy/eobj/doc/head.html
new file mode 100644
index 0000000000..9227da5ee4
--- /dev/null
+++ b/legacy/eobj/doc/head.html
@@ -0,0 +1,67 @@
1<html>
2<head>
3 <title>$title</title>
4 <meta http-equiv="content-type" content="text/html;charset=UTF-8">
5 <meta name="author" content="Andres Blanc" >
6
7 <link rel="icon" href="img/favicon.png" type="image/x-icon">
8 <link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
9 <link rel="icon" href="img/favicon.png" type="image/ico">
10 <link rel="shortcut icon" href="img/favicon.png" type="image/ico">
11
12 <link rel="stylesheet" type="text/css" href="e.css">
13 <link rel="stylesheet" type="text/css" href="edoxy.css">
14</head>
15
16<body>
17
18<div id="container">
19
20<div id="header">
21<div class="layout">
22
23 <h1><span>Enlightenment</span></h1>
24 <h2><span>Beauty at your fingertips</span></h2>
25
26 <table cellspacing="0" cellpadding="0" width="100%"><tr>
27 <td id="header_logo">
28 <a href="http://www.enlightenment.org"></a>
29 </td>
30 <td id="header_menu">
31 <table cellspacing="0" cellpadding="0" align="right"><tr>
32 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=home">Home</a></td>
33 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=news">News</a></td>
34 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=about">About</a></td>
35 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=download">Download</a></td>
36 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=support">Support</a></td>
37 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></td>
38 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contact">Contact</a></td>
39 <td class="nav_passive"><a class="nav_passive" href="http://trac.enlightenment.org/e">Tracker</a></td>
40 <td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=docs">Docs</a></td>
41 </tr></table>
42 </td>
43 <td id="header_last"></td>
44 </tr></table>
45
46 <div class="doxytitle">
47 $projectname Documentation <small>at $date</small>
48 </div>
49
50 <div class="menu-container">
51 <div class="submenu">
52 <ul class="current">
53 <li><a href="files.html">Files</a></li>
54 <li><a href="modules.html">Modules</a></li>
55 <li><a href="pages.html">Related Pages</a></li>
56 <li class="current"><a href="index.html">Main Page</a></li>
57 </ul>
58 </div>
59 </div>
60
61
62 <div class="clear"></div>
63</div>
64</div>
65
66<div id="content">
67<div class="layout">
diff --git a/legacy/eobj/doc/img/e.png b/legacy/eobj/doc/img/e.png
new file mode 100644
index 0000000000..b3884a5cbc
--- /dev/null
+++ b/legacy/eobj/doc/img/e.png
Binary files differ
diff --git a/legacy/eobj/doc/img/edoxy.css b/legacy/eobj/doc/img/edoxy.css
new file mode 100644
index 0000000000..3caf7a9736
--- /dev/null
+++ b/legacy/eobj/doc/img/edoxy.css
@@ -0,0 +1,483 @@
1/*
2 * This file contain a custom doxygen style to match e.org graphics
3 */
4
5
6
7/* BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
8 font-family: Geneva, Arial, Helvetica, sans-serif;
9}*/
10BODY, TD {
11 font-size: 12px;
12}
13H1 {
14 text-align: center;
15 font-size: 160%;
16}
17H2 {
18 font-size: 120%;
19}
20H3 {
21 font-size: 100%;
22}
23CAPTION {
24 font-weight: bold
25}
26DIV.qindex {
27 width: 100%;
28 background-color: #e8eef2;
29 border: 1px solid #84b0c7;
30 text-align: center;
31 margin: 2px;
32 padding: 2px;
33 line-height: 140%;
34}
35DIV.navpath {
36 width: 100%;
37 background-color: #e8eef2;
38 border: 1px solid #84b0c7;
39 text-align: center;
40 margin: 2px;
41 padding: 2px;
42 line-height: 140%;
43}
44DIV.navtab {
45 background-color: #e8eef2;
46 border: 1px solid #84b0c7;
47 text-align: center;
48 margin: 2px;
49 margin-right: 15px;
50 padding: 2px;
51}
52TD.navtab {
53 font-size: 70%;
54}
55A.qindex {
56 text-decoration: none;
57 font-weight: bold;
58 color: #1A419D;
59}
60A.qindex:visited {
61 text-decoration: none;
62 font-weight: bold;
63 color: #1A419D
64}
65A.qindex:hover {
66 text-decoration: none;
67 background-color: #ddddff;
68}
69A.qindexHL {
70 text-decoration: none;
71 font-weight: bold;
72 background-color: #6666cc;
73 color: #ffffff;
74 border: 1px double #9295C2;
75}
76A.qindexHL:hover {
77 text-decoration: none;
78 background-color: #6666cc;
79 color: #ffffff;
80}
81A.qindexHL:visited {
82 text-decoration: none;
83 background-color: #6666cc;
84 color: #ffffff
85}
86A.el {
87 text-decoration: none;
88 font-weight: bold
89}
90A.elRef {
91 font-weight: bold
92}
93A.code:link {
94 text-decoration: none;
95 font-weight: normal;
96 color: #0000FF
97}
98A.code:visited {
99 text-decoration: none;
100 font-weight: normal;
101 color: #0000FF
102}
103A.codeRef:link {
104 font-weight: normal;
105 color: #0000FF
106}
107A.codeRef:visited {
108 font-weight: normal;
109 color: #0000FF
110}
111A:hover, A:visited:hover {
112 text-decoration: none;
113 /* background-color: #f2f2ff; */
114 color: #000055;
115}
116A.anchor {
117 color: #000;
118}
119DL.el {
120 margin-left: -1cm
121}
122.fragment {
123 font-family: monospace, fixed;
124 font-size: 95%;
125}
126PRE.fragment {
127 border: 1px solid #CCCCCC;
128 background-color: #f5f5f5;
129 margin-top: 4px;
130 margin-bottom: 4px;
131 margin-left: 2px;
132 margin-right: 8px;
133 padding-left: 6px;
134 padding-right: 6px;
135 padding-top: 4px;
136 padding-bottom: 4px;
137}
138DIV.ah {
139 background-color: black;
140 font-weight: bold;
141 color: #ffffff;
142 margin-bottom: 3px;
143 margin-top: 3px
144}
145
146DIV.groupHeader {
147 margin-left: 16px;
148 margin-top: 12px;
149 margin-bottom: 6px;
150 font-weight: bold;
151}
152DIV.groupText {
153 margin-left: 16px;
154 font-style: italic;
155 font-size: 90%
156}
157/*BODY {
158 background: white;
159 color: black;
160 margin-right: 20px;
161 margin-left: 20px;
162}*/
163TD.indexkey {
164 background-color: #e8eef2;
165 font-weight: bold;
166 padding-right : 10px;
167 padding-top : 2px;
168 padding-left : 10px;
169 padding-bottom : 2px;
170 margin-left : 0px;
171 margin-right : 0px;
172 margin-top : 2px;
173 margin-bottom : 2px;
174 border: 1px solid #CCCCCC;
175}
176TD.indexvalue {
177 background-color: #e8eef2;
178 font-style: italic;
179 padding-right : 10px;
180 padding-top : 2px;
181 padding-left : 10px;
182 padding-bottom : 2px;
183 margin-left : 0px;
184 margin-right : 0px;
185 margin-top : 2px;
186 margin-bottom : 2px;
187 border: 1px solid #CCCCCC;
188}
189TR.memlist {
190 background-color: #f0f0f0;
191}
192P.formulaDsp {
193 text-align: center;
194}
195IMG.formulaDsp {
196}
197IMG.formulaInl {
198 vertical-align: middle;
199}
200SPAN.keyword { color: #008000 }
201SPAN.keywordtype { color: #604020 }
202SPAN.keywordflow { color: #e08000 }
203SPAN.comment { color: #800000 }
204SPAN.preprocessor { color: #806020 }
205SPAN.stringliteral { color: #002080 }
206SPAN.charliteral { color: #008080 }
207SPAN.vhdldigit { color: #ff00ff }
208SPAN.vhdlchar { color: #000000 }
209SPAN.vhdlkeyword { color: #700070 }
210SPAN.vhdllogic { color: #ff0000 }
211
212.mdescLeft {
213 padding: 0px 8px 4px 8px;
214 font-size: 80%;
215 font-style: italic;
216 background-color: #FAFAFA;
217 border-top: 1px none #E0E0E0;
218 border-right: 1px none #E0E0E0;
219 border-bottom: 1px none #E0E0E0;
220 border-left: 1px none #E0E0E0;
221 margin: 0px;
222}
223.mdescRight {
224 padding: 0px 8px 4px 8px;
225 font-size: 80%;
226 font-style: italic;
227 background-color: #FAFAFA;
228 border-top: 1px none #E0E0E0;
229 border-right: 1px none #E0E0E0;
230 border-bottom: 1px none #E0E0E0;
231 border-left: 1px none #E0E0E0;
232 margin: 0px;
233}
234.memItemLeft {
235 padding: 1px 0px 0px 8px;
236 margin: 4px;
237 border-top-width: 1px;
238 border-right-width: 1px;
239 border-bottom-width: 1px;
240 border-left-width: 1px;
241 border-top-color: #E0E0E0;
242 border-right-color: #E0E0E0;
243 border-bottom-color: #E0E0E0;
244 border-left-color: #E0E0E0;
245 border-top-style: solid;
246 border-right-style: none;
247 border-bottom-style: none;
248 border-left-style: none;
249 background-color: #FAFAFA;
250 font-size: 80%;
251}
252.memItemRight {
253 padding: 1px 8px 0px 8px;
254 margin: 4px;
255 border-top-width: 1px;
256 border-right-width: 1px;
257 border-bottom-width: 1px;
258 border-left-width: 1px;
259 border-top-color: #E0E0E0;
260 border-right-color: #E0E0E0;
261 border-bottom-color: #E0E0E0;
262 border-left-color: #E0E0E0;
263 border-top-style: solid;
264 border-right-style: none;
265 border-bottom-style: none;
266 border-left-style: none;
267 background-color: #FAFAFA;
268 font-size: 80%;
269}
270.memTemplItemLeft {
271 padding: 1px 0px 0px 8px;
272 margin: 4px;
273 border-top-width: 1px;
274 border-right-width: 1px;
275 border-bottom-width: 1px;
276 border-left-width: 1px;
277 border-top-color: #E0E0E0;
278 border-right-color: #E0E0E0;
279 border-bottom-color: #E0E0E0;
280 border-left-color: #E0E0E0;
281 border-top-style: none;
282 border-right-style: none;
283 border-bottom-style: none;
284 border-left-style: none;
285 background-color: #FAFAFA;
286 font-size: 80%;
287}
288.memTemplItemRight {
289 padding: 1px 8px 0px 8px;
290 margin: 4px;
291 border-top-width: 1px;
292 border-right-width: 1px;
293 border-bottom-width: 1px;
294 border-left-width: 1px;
295 border-top-color: #E0E0E0;
296 border-right-color: #E0E0E0;
297 border-bottom-color: #E0E0E0;
298 border-left-color: #E0E0E0;
299 border-top-style: none;
300 border-right-style: none;
301 border-bottom-style: none;
302 border-left-style: none;
303 background-color: #FAFAFA;
304 font-size: 80%;
305}
306.memTemplParams {
307 padding: 1px 0px 0px 8px;
308 margin: 4px;
309 border-top-width: 1px;
310 border-right-width: 1px;
311 border-bottom-width: 1px;
312 border-left-width: 1px;
313 border-top-color: #E0E0E0;
314 border-right-color: #E0E0E0;
315 border-bottom-color: #E0E0E0;
316 border-left-color: #E0E0E0;
317 border-top-style: solid;
318 border-right-style: none;
319 border-bottom-style: none;
320 border-left-style: none;
321 color: #606060;
322 background-color: #FAFAFA;
323 font-size: 80%;
324}
325.search {
326 color: #003399;
327 font-weight: bold;
328}
329FORM.search {
330 margin-bottom: 0px;
331 margin-top: 0px;
332}
333INPUT.search {
334 font-size: 75%;
335 color: #000080;
336 font-weight: normal;
337 background-color: #e8eef2;
338}
339TD.tiny {
340 font-size: 75%;
341}
342a {
343 color: #1A41A8;
344}
345a:visited {
346 color: #2A3798;
347}
348.dirtab {
349 padding: 4px;
350 border-collapse: collapse;
351 border: 1px solid #84b0c7;
352}
353TH.dirtab {
354 background: #e8eef2;
355 font-weight: bold;
356}
357HR {
358 height: 1px;
359 border: none;
360 border-top: 1px solid black;
361}
362
363/* Style for detailed member documentation */
364.memtemplate {
365 font-size: 80%;
366 color: #606060;
367 font-weight: normal;
368 margin-left: 3px;
369}
370.memnav {
371 background-color: #e8eef2;
372 border: 1px solid #84b0c7;
373 text-align: center;
374 margin: 2px;
375 margin-right: 15px;
376 padding: 2px;
377}
378.memitem {
379 padding: 4px;
380 background-color: #eef3f5;
381 border-width: 1px;
382 border-style: solid;
383 border-color: #dedeee;
384 -moz-border-radius: 8px 8px 8px 8px;
385}
386.memname {
387 white-space: nowrap;
388 font-weight: bold;
389}
390.memdoc{
391 padding-left: 10px;
392}
393.memproto {
394 background-color: #d5e1e8;
395 width: 100%;
396 border-width: 1px;
397 border-style: solid;
398 border-color: #84b0c7;
399 font-weight: bold;
400 -moz-border-radius: 8px 8px 8px 8px;
401}
402.paramkey {
403 text-align: right;
404}
405.paramtype {
406 white-space: nowrap;
407}
408.paramname {
409 color: #602020;
410 font-style: italic;
411 white-space: nowrap;
412}
413/* End Styling for detailed member documentation */
414
415/* for the tree view */
416.ftvtree {
417 font-family: sans-serif;
418 margin:0.5em;
419}
420/* these are for tree view when used as main index */
421.directory {
422 font-size: 9pt;
423 font-weight: bold;
424}
425.directory h3 {
426 margin: 0px;
427 margin-top: 1em;
428 font-size: 11pt;
429}
430
431/* The following two styles can be used to replace the root node title */
432/* with an image of your choice. Simply uncomment the next two styles, */
433/* specify the name of your image and be sure to set 'height' to the */
434/* proper pixel height of your image. */
435
436/* .directory h3.swap { */
437/* height: 61px; */
438/* background-repeat: no-repeat; */
439/* background-image: url("yourimage.gif"); */
440/* } */
441/* .directory h3.swap span { */
442/* display: none; */
443/* } */
444
445.directory > h3 {
446 margin-top: 0;
447}
448.directory p {
449 margin: 0px;
450 white-space: nowrap;
451}
452.directory div {
453 display: none;
454 margin: 0px;
455}
456.directory img {
457 vertical-align: -30%;
458}
459/* these are for tree view when not used as main index */
460.directory-alt {
461 font-size: 100%;
462 font-weight: bold;
463}
464.directory-alt h3 {
465 margin: 0px;
466 margin-top: 1em;
467 font-size: 11pt;
468}
469.directory-alt > h3 {
470 margin-top: 0;
471}
472.directory-alt p {
473 margin: 0px;
474 white-space: nowrap;
475}
476.directory-alt div {
477 display: none;
478 margin: 0px;
479}
480.directory-alt img {
481 vertical-align: -30%;
482}
483
diff --git a/legacy/eobj/doc/img/foot_bg.png b/legacy/eobj/doc/img/foot_bg.png
new file mode 100644
index 0000000000..b24f3a48b4
--- /dev/null
+++ b/legacy/eobj/doc/img/foot_bg.png
Binary files differ
diff --git a/legacy/eobj/doc/img/head_bg.png b/legacy/eobj/doc/img/head_bg.png
new file mode 100644
index 0000000000..081dc131e4
--- /dev/null
+++ b/legacy/eobj/doc/img/head_bg.png
Binary files differ
diff --git a/legacy/eobj/doc/img/header_menu_background.png b/legacy/eobj/doc/img/header_menu_background.png
new file mode 100644
index 0000000000..e978743651
--- /dev/null
+++ b/legacy/eobj/doc/img/header_menu_background.png
Binary files differ
diff --git a/legacy/eobj/doc/img/header_menu_background_last.png b/legacy/eobj/doc/img/header_menu_background_last.png
new file mode 100644
index 0000000000..88c116c8c8
--- /dev/null
+++ b/legacy/eobj/doc/img/header_menu_background_last.png
Binary files differ
diff --git a/legacy/eobj/doc/img/header_menu_unselected_background.png b/legacy/eobj/doc/img/header_menu_unselected_background.png
new file mode 100644
index 0000000000..50e5fd8d3d
--- /dev/null
+++ b/legacy/eobj/doc/img/header_menu_unselected_background.png
Binary files differ
diff --git a/legacy/eobj/doc/img/logo.png b/legacy/eobj/doc/img/logo.png
new file mode 100644
index 0000000000..b3884a5cbc
--- /dev/null
+++ b/legacy/eobj/doc/img/logo.png
Binary files differ
diff --git a/legacy/eobj/doc/img/menu_bg.png b/legacy/eobj/doc/img/menu_bg.png
new file mode 100644
index 0000000000..e978743651
--- /dev/null
+++ b/legacy/eobj/doc/img/menu_bg.png
Binary files differ
diff --git a/legacy/eobj/doc/img/menu_bg_current.png b/legacy/eobj/doc/img/menu_bg_current.png
new file mode 100644
index 0000000000..de97c9268e
--- /dev/null
+++ b/legacy/eobj/doc/img/menu_bg_current.png
Binary files differ
diff --git a/legacy/eobj/doc/img/menu_bg_hover.png b/legacy/eobj/doc/img/menu_bg_hover.png
new file mode 100644
index 0000000000..3fd851d075
--- /dev/null
+++ b/legacy/eobj/doc/img/menu_bg_hover.png
Binary files differ
diff --git a/legacy/eobj/doc/img/menu_bg_last.png b/legacy/eobj/doc/img/menu_bg_last.png
new file mode 100644
index 0000000000..88c116c8c8
--- /dev/null
+++ b/legacy/eobj/doc/img/menu_bg_last.png
Binary files differ
diff --git a/legacy/eobj/doc/img/menu_bg_unsel.png b/legacy/eobj/doc/img/menu_bg_unsel.png
new file mode 100644
index 0000000000..50e5fd8d3d
--- /dev/null
+++ b/legacy/eobj/doc/img/menu_bg_unsel.png
Binary files differ