summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--legacy/ethumb/INSTALL143
-rw-r--r--legacy/ethumb/Makefile.am8
-rwxr-xr-xlegacy/ethumb/autogen.sh9
-rw-r--r--legacy/ethumb/configure.ac3
-rw-r--r--legacy/ethumb/doc/Doxyfile1356
-rw-r--r--legacy/ethumb/doc/Makefile.am23
-rw-r--r--legacy/ethumb/doc/e.css218
-rw-r--r--legacy/ethumb/doc/foot.html19
-rw-r--r--legacy/ethumb/doc/head.html64
-rw-r--r--legacy/ethumb/doc/img/e.pngbin0 -> 3825 bytes
-rw-r--r--legacy/ethumb/doc/img/edoxy.css483
-rw-r--r--legacy/ethumb/doc/img/foot_bg.pngbin0 -> 173 bytes
-rw-r--r--legacy/ethumb/doc/img/head_bg.pngbin0 -> 214 bytes
-rw-r--r--legacy/ethumb/doc/img/menu_bg.pngbin0 -> 192 bytes
-rw-r--r--legacy/ethumb/doc/img/menu_bg_current.pngbin0 -> 1200 bytes
-rw-r--r--legacy/ethumb/doc/img/menu_bg_hover.pngbin0 -> 3278 bytes
-rw-r--r--legacy/ethumb/doc/img/menu_bg_last.pngbin0 -> 637 bytes
-rw-r--r--legacy/ethumb/doc/img/menu_bg_unsel.pngbin0 -> 1596 bytes
-rw-r--r--legacy/ethumb/m4/Makefile.am3
-rw-r--r--legacy/ethumb/m4/efl_doxygen.m497
-rw-r--r--legacy/ethumb/src/lib/client/Ethumb_Client.c73
-rw-r--r--legacy/ethumb/src/lib/client/Ethumb_Client.h59
22 files changed, 2504 insertions, 54 deletions
diff --git a/legacy/ethumb/INSTALL b/legacy/ethumb/INSTALL
index 23e5f25d0e..8b82ade08e 100644
--- a/legacy/ethumb/INSTALL
+++ b/legacy/ethumb/INSTALL
@@ -1,16 +1,19 @@
1Installation Instructions 1Installation Instructions
2************************* 2*************************
3 3
4Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free 4Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
5Software Foundation, Inc. 52006, 2007, 2008 Free Software Foundation, Inc.
6 6
7This file is free documentation; the Free Software Foundation gives 7 This file is free documentation; the Free Software Foundation gives
8unlimited permission to copy, distribute and modify it. 8unlimited permission to copy, distribute and modify it.
9 9
10Basic Installation 10Basic Installation
11================== 11==================
12 12
13These are generic installation instructions. 13 Briefly, the shell commands `./configure; make; make install' should
14configure, build, and install this package. The following
15more-detailed instructions are generic; see the `README' file for
16instructions specific to this package.
14 17
15 The `configure' shell script attempts to guess correct values for 18 The `configure' shell script attempts to guess correct values for
16various system-dependent variables used during compilation. It uses 19various system-dependent variables used during compilation. It uses
@@ -23,9 +26,9 @@ debugging `configure').
23 26
24 It can also use an optional file (typically called `config.cache' 27 It can also use an optional file (typically called `config.cache'
25and enabled with `--cache-file=config.cache' or simply `-C') that saves 28and enabled with `--cache-file=config.cache' or simply `-C') that saves
26the results of its tests to speed up reconfiguring. (Caching is 29the results of its tests to speed up reconfiguring. Caching is
27disabled by default to prevent problems with accidental use of stale 30disabled by default to prevent problems with accidental use of stale
28cache files.) 31cache files.
29 32
30 If you need to do unusual things to compile the package, please try 33 If you need to do unusual things to compile the package, please try
31to figure out how `configure' could check whether to do them, and mail 34to figure out how `configure' could check whether to do them, and mail
@@ -35,20 +38,17 @@ some point `config.cache' contains results you don't want to keep, you
35may remove or edit it. 38may remove or edit it.
36 39
37 The file `configure.ac' (or `configure.in') is used to create 40 The file `configure.ac' (or `configure.in') is used to create
38`configure' by a program called `autoconf'. You only need 41`configure' by a program called `autoconf'. You need `configure.ac' if
39`configure.ac' if you want to change it or regenerate `configure' using 42you want to change it or regenerate `configure' using a newer version
40a newer version of `autoconf'. 43of `autoconf'.
41 44
42The simplest way to compile this package is: 45The simplest way to compile this package is:
43 46
44 1. `cd' to the directory containing the package's source code and type 47 1. `cd' to the directory containing the package's source code and type
45 `./configure' to configure the package for your system. If you're 48 `./configure' to configure the package for your system.
46 using `csh' on an old version of System V, you might need to type
47 `sh ./configure' instead to prevent `csh' from trying to execute
48 `configure' itself.
49 49
50 Running `configure' takes awhile. While running, it prints some 50 Running `configure' might take a while. While running, it prints
51 messages telling which features it is checking for. 51 some messages telling which features it is checking for.
52 52
53 2. Type `make' to compile the package. 53 2. Type `make' to compile the package.
54 54
@@ -67,42 +67,57 @@ The simplest way to compile this package is:
67 all sorts of other programs in order to regenerate files that came 67 all sorts of other programs in order to regenerate files that came
68 with the distribution. 68 with the distribution.
69 69
70 6. Often, you can also type `make uninstall' to remove the installed
71 files again.
72
70Compilers and Options 73Compilers and Options
71===================== 74=====================
72 75
73Some systems require unusual options for compilation or linking that the 76 Some systems require unusual options for compilation or linking that
74`configure' script does not know about. Run `./configure --help' for 77the `configure' script does not know about. Run `./configure --help'
75details on some of the pertinent environment variables. 78for details on some of the pertinent environment variables.
76 79
77 You can give `configure' initial values for configuration parameters 80 You can give `configure' initial values for configuration parameters
78by setting variables in the command line or in the environment. Here 81by setting variables in the command line or in the environment. Here
79is an example: 82is an example:
80 83
81 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix 84 ./configure CC=c99 CFLAGS=-g LIBS=-lposix
82 85
83 *Note Defining Variables::, for more details. 86 *Note Defining Variables::, for more details.
84 87
85Compiling For Multiple Architectures 88Compiling For Multiple Architectures
86==================================== 89====================================
87 90
88You can compile the package for more than one kind of computer at the 91 You can compile the package for more than one kind of computer at the
89same time, by placing the object files for each architecture in their 92same time, by placing the object files for each architecture in their
90own directory. To do this, you must use a version of `make' that 93own directory. To do this, you can use GNU `make'. `cd' to the
91supports the `VPATH' variable, such as GNU `make'. `cd' to the
92directory where you want the object files and executables to go and run 94directory where you want the object files and executables to go and run
93the `configure' script. `configure' automatically checks for the 95the `configure' script. `configure' automatically checks for the
94source code in the directory that `configure' is in and in `..'. 96source code in the directory that `configure' is in and in `..'.
95 97
96 If you have to use a `make' that does not support the `VPATH' 98 With a non-GNU `make', it is safer to compile the package for one
97variable, you have to compile the package for one architecture at a 99architecture at a time in the source code directory. After you have
98time in the source code directory. After you have installed the 100installed the package for one architecture, use `make distclean' before
99package for one architecture, use `make distclean' before reconfiguring 101reconfiguring for another architecture.
100for another architecture. 102
103 On MacOS X 10.5 and later systems, you can create libraries and
104executables that work on multiple system types--known as "fat" or
105"universal" binaries--by specifying multiple `-arch' options to the
106compiler but only a single `-arch' option to the preprocessor. Like
107this:
108
109 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
110 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
111 CPP="gcc -E" CXXCPP="g++ -E"
112
113 This is not guaranteed to produce working output in all cases, you
114may have to build one architecture at a time and combine the results
115using the `lipo' tool if you have problems.
101 116
102Installation Names 117Installation Names
103================== 118==================
104 119
105By default, `make install' installs the package's commands under 120 By default, `make install' installs the package's commands under
106`/usr/local/bin', include files under `/usr/local/include', etc. You 121`/usr/local/bin', include files under `/usr/local/include', etc. You
107can specify an installation prefix other than `/usr/local' by giving 122can specify an installation prefix other than `/usr/local' by giving
108`configure' the option `--prefix=PREFIX'. 123`configure' the option `--prefix=PREFIX'.
@@ -125,7 +140,7 @@ option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
125Optional Features 140Optional Features
126================= 141=================
127 142
128Some packages pay attention to `--enable-FEATURE' options to 143 Some packages pay attention to `--enable-FEATURE' options to
129`configure', where FEATURE indicates an optional part of the package. 144`configure', where FEATURE indicates an optional part of the package.
130They may also pay attention to `--with-PACKAGE' options, where PACKAGE 145They may also pay attention to `--with-PACKAGE' options, where PACKAGE
131is something like `gnu-as' or `x' (for the X Window System). The 146is something like `gnu-as' or `x' (for the X Window System). The
@@ -137,14 +152,36 @@ find the X include and library files automatically, but if it doesn't,
137you can use the `configure' options `--x-includes=DIR' and 152you can use the `configure' options `--x-includes=DIR' and
138`--x-libraries=DIR' to specify their locations. 153`--x-libraries=DIR' to specify their locations.
139 154
155Particular systems
156==================
157
158 On HP-UX, the default C compiler is not ANSI C compatible. If GNU
159CC is not installed, it is recommended to use the following options in
160order to use an ANSI C compiler:
161
162 ./configure CC="cc -Ae"
163
164and if that doesn't work, install pre-built binaries of GCC for HP-UX.
165
166 On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
167parse its `<wchar.h>' header file. The option `-nodtk' can be used as
168a workaround. If GNU CC is not installed, it is therefore recommended
169to try
170
171 ./configure CC="cc"
172
173and if that doesn't work, try
174
175 ./configure CC="cc -nodtk"
176
140Specifying the System Type 177Specifying the System Type
141========================== 178==========================
142 179
143There may be some features `configure' cannot figure out automatically, 180 There may be some features `configure' cannot figure out
144but needs to determine by the type of machine the package will run on. 181automatically, but needs to determine by the type of machine the package
145Usually, assuming the package is built to be run on the _same_ 182will run on. Usually, assuming the package is built to be run on the
146architectures, `configure' can figure that out, but if it prints a 183_same_ architectures, `configure' can figure that out, but if it prints
147message saying it cannot guess the machine type, give it the 184a message saying it cannot guess the machine type, give it the
148`--build=TYPE' option. TYPE can either be a short name for the system 185`--build=TYPE' option. TYPE can either be a short name for the system
149type, such as `sun4', or a canonical name which has the form: 186type, such as `sun4', or a canonical name which has the form:
150 187
@@ -170,9 +207,9 @@ eventually be run) with `--host=TYPE'.
170Sharing Defaults 207Sharing Defaults
171================ 208================
172 209
173If you want to set default values for `configure' scripts to share, you 210 If you want to set default values for `configure' scripts to share,
174can create a site shell script called `config.site' that gives default 211you can create a site shell script called `config.site' that gives
175values for variables like `CC', `cache_file', and `prefix'. 212default values for variables like `CC', `cache_file', and `prefix'.
176`configure' looks for `PREFIX/share/config.site' if it exists, then 213`configure' looks for `PREFIX/share/config.site' if it exists, then
177`PREFIX/etc/config.site' if it exists. Or, you can set the 214`PREFIX/etc/config.site' if it exists. Or, you can set the
178`CONFIG_SITE' environment variable to the location of the site script. 215`CONFIG_SITE' environment variable to the location of the site script.
@@ -181,7 +218,7 @@ A warning: not all `configure' scripts look for a site script.
181Defining Variables 218Defining Variables
182================== 219==================
183 220
184Variables not defined in a site shell script can be set in the 221 Variables not defined in a site shell script can be set in the
185environment passed to `configure'. However, some packages may run 222environment passed to `configure'. However, some packages may run
186configure again during the build, and the customized values of these 223configure again during the build, and the customized values of these
187variables may be lost. In order to avoid this problem, you should set 224variables may be lost. In order to avoid this problem, you should set
@@ -190,21 +227,29 @@ them in the `configure' command line, using `VAR=value'. For example:
190 ./configure CC=/usr/local2/bin/gcc 227 ./configure CC=/usr/local2/bin/gcc
191 228
192causes the specified `gcc' to be used as the C compiler (unless it is 229causes the specified `gcc' to be used as the C compiler (unless it is
193overridden in the site shell script). Here is a another example: 230overridden in the site shell script).
194 231
195 /bin/bash ./configure CONFIG_SHELL=/bin/bash 232Unfortunately, this technique does not work for `CONFIG_SHELL' due to
233an Autoconf bug. Until the bug is fixed you can use this workaround:
196 234
197Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent 235 CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
198configuration-related scripts to be executed by `/bin/bash'.
199 236
200`configure' Invocation 237`configure' Invocation
201====================== 238======================
202 239
203`configure' recognizes the following options to control how it operates. 240 `configure' recognizes the following options to control how it
241operates.
204 242
205`--help' 243`--help'
206`-h' 244`-h'
207 Print a summary of the options to `configure', and exit. 245 Print a summary of all of the options to `configure', and exit.
246
247`--help=short'
248`--help=recursive'
249 Print a summary of the options unique to this package's
250 `configure', and exit. The `short' variant lists options used
251 only in the top level, while the `recursive' variant lists options
252 also present in any nested packages.
208 253
209`--version' 254`--version'
210`-V' 255`-V'
@@ -231,6 +276,16 @@ configuration-related scripts to be executed by `/bin/bash'.
231 Look for the package's source code in directory DIR. Usually 276 Look for the package's source code in directory DIR. Usually
232 `configure' can determine that directory automatically. 277 `configure' can determine that directory automatically.
233 278
279`--prefix=DIR'
280 Use DIR as the installation prefix. *Note Installation Names::
281 for more details, including other options available for fine-tuning
282 the installation locations.
283
284`--no-create'
285`-n'
286 Run the configure checks, but stop before creating any output
287 files.
288
234`configure' also accepts some other, not widely useful, options. Run 289`configure' also accepts some other, not widely useful, options. Run
235`configure --help' for more details. 290`configure --help' for more details.
236 291
diff --git a/legacy/ethumb/Makefile.am b/legacy/ethumb/Makefile.am
index 9892d938b0..6232279736 100644
--- a/legacy/ethumb/Makefile.am
+++ b/legacy/ethumb/Makefile.am
@@ -29,6 +29,12 @@ service_DATA = org.enlightenment.Ethumb.service
29 29
30endif 30endif
31 31
32SUBDIRS = m4 src data 32SUBDIRS = m4 src data doc
33 33
34ACLOCAL_AMFLAGS = -I m4 34ACLOCAL_AMFLAGS = -I m4
35
36.PHONY: doc
37
38doc:
39 @echo "entering doc/"
40 $(MAKE) -C doc doc
diff --git a/legacy/ethumb/autogen.sh b/legacy/ethumb/autogen.sh
index 5bbd4d9c50..8610825bfd 100755
--- a/legacy/ethumb/autogen.sh
+++ b/legacy/ethumb/autogen.sh
@@ -1,13 +1,6 @@
1#!/bin/sh 1#!/bin/sh
2 2
3rm -rf autom4te.cache 3autoreconf -f -i
4rm -f aclocal.m4 ltmain.sh
5
6echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS -I m4 || exit 1
7echo "Running autoheader..." ; autoheader || exit 1
8echo "Running autoconf..." ; autoconf || exit 1
9echo "Running libtoolize..." ; (libtoolize --copy --automake || glibtoolize --automake) || exit 1
10echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
11 4
12if [ -z "$NOCONFIGURE" ]; then 5if [ -z "$NOCONFIGURE" ]; then
13 ./configure "$@" 6 ./configure "$@"
diff --git a/legacy/ethumb/configure.ac b/legacy/ethumb/configure.ac
index 4b93482af8..6d97e66171 100644
--- a/legacy/ethumb/configure.ac
+++ b/legacy/ethumb/configure.ac
@@ -40,6 +40,8 @@ AC_SUBST(pluginsdir)
40AS_AC_EXPAND(PLUGINSDIR, $pluginsdir) 40AS_AC_EXPAND(PLUGINSDIR, $pluginsdir)
41AC_DEFINE_UNQUOTED(PLUGINSDIR, ["$PLUGINSDIR"], [Where plugins are installed.]) 41AC_DEFINE_UNQUOTED(PLUGINSDIR, ["$PLUGINSDIR"], [Where plugins are installed.])
42 42
43EFL_CHECK_DOXYGEN([build_doc="yes"], [build_doc="no"])
44
43PKG_CHECK_MODULES(EINA, [eina-0]) 45PKG_CHECK_MODULES(EINA, [eina-0])
44PKG_CHECK_MODULES(EVAS, [evas]) 46PKG_CHECK_MODULES(EVAS, [evas])
45PKG_CHECK_MODULES(ECORE, [ecore]) 47PKG_CHECK_MODULES(ECORE, [ecore])
@@ -110,4 +112,5 @@ src/tests/Makefile
110data/Makefile 112data/Makefile
111data/frames/Makefile 113data/frames/Makefile
112m4/Makefile 114m4/Makefile
115doc/Makefile
113]) 116])
diff --git a/legacy/ethumb/doc/Doxyfile b/legacy/ethumb/doc/Doxyfile
new file mode 100644
index 0000000000..0000517043
--- /dev/null
+++ b/legacy/ethumb/doc/Doxyfile
@@ -0,0 +1,1356 @@
1# Doxyfile 1.5.5
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 = Ethumb
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 =
35
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
39# where doxygen was started. If left blank the current directory will be used.
40
41OUTPUT_DIRECTORY = .
42
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
48# otherwise cause performance problems for the file system.
49
50CREATE_SUBDIRS = NO
51
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61# and Ukrainian.
62
63OUTPUT_LANGUAGE = English
64
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
68# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC = YES
71
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF = YES
78
79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
87# "represents" "a" "an" "the"
88
89ABBREVIATE_BRIEF =
90
91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92# Doxygen will generate a detailed section even if there is only a brief
93# description.
94
95ALWAYS_DETAILED_SEC = NO
96
97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98# inherited members of a class in the documentation of that class as if those
99# members were ordinary class members. Constructors, destructors and assignment
100# operators of the base classes will not be shown.
101
102INLINE_INHERITED_MEMB = NO
103
104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105# path before files name in the file list and in the header files. If set
106# to NO the shortest path that makes the file name unique will be used.
107
108FULL_PATH_NAMES = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111# can be used to strip a user-defined part of the path. Stripping is
112# only done if one of the specified strings matches the left-hand part of
113# the path. The tag can be used to show relative paths in the file list.
114# If left blank the directory from which doxygen is run is used as the
115# path to strip.
116
117STRIP_FROM_PATH =
118
119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120# the path mentioned in the documentation of a class, which tells
121# the reader which header file to include in order to use a class.
122# If left blank only the name of the header file containing the class
123# definition is used. Otherwise one should specify the include paths that
124# are normally passed to the compiler using the -I flag.
125
126STRIP_FROM_INC_PATH =
127
128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129# (but less readable) file names. This can be useful is your file systems
130# doesn't support long names like on DOS, Mac, or CD-ROM.
131
132SHORT_NAMES = NO
133
134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135# will interpret the first line (until the first dot) of a JavaDoc-style
136# comment as the brief description. If set to NO, the JavaDoc
137# comments will behave just like regular Qt-style comments
138# (thus requiring an explicit @brief command for a brief description.)
139
140JAVADOC_AUTOBRIEF = YES
141
142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143# interpret the first line (until the first dot) of a Qt-style
144# comment as the brief description. If set to NO, the comments
145# will behave just like regular Qt-style comments (thus requiring
146# an explicit \brief command for a brief description.)
147
148QT_AUTOBRIEF = NO
149
150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152# comments) as a brief description. This used to be the default behaviour.
153# The new default is to treat a multi-line C++ comment block as a detailed
154# description. Set this tag to YES if you prefer the old behaviour instead.
155
156MULTILINE_CPP_IS_BRIEF = NO
157
158# If the DETAILS_AT_TOP tag is set to YES then Doxygen
159# will output the detailed description near the top, like JavaDoc.
160# If set to NO, the detailed description appears after the member
161# documentation.
162
163DETAILS_AT_TOP = NO
164
165# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166# member inherits the documentation from any documented member that it
167# re-implements.
168
169INHERIT_DOCS = YES
170
171# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172# a new page for each member. If set to NO, the documentation of a member will
173# be part of the file/class/namespace that contains it.
174
175SEPARATE_MEMBER_PAGES = NO
176
177# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178# Doxygen uses this value to replace tabs by spaces in code fragments.
179
180TAB_SIZE = 2
181
182# This tag can be used to specify a number of aliases that acts
183# as commands in the documentation. An alias has the form "name=value".
184# For example adding "sideeffect=\par Side Effects:\n" will allow you to
185# put the command \sideeffect (or @sideeffect) in the documentation, which
186# will result in a user-defined paragraph with heading "Side Effects:".
187# You can put \n's in the value part of an alias to insert newlines.
188
189ALIASES =
190
191# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192# sources only. Doxygen will then generate output that is more tailored for C.
193# For instance, some of the names that are used will be different. The list
194# of all members will be omitted, etc.
195
196OPTIMIZE_OUTPUT_FOR_C = YES
197
198# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199# sources only. Doxygen will then generate output that is more tailored for
200# Java. For instance, namespaces will be presented as packages, qualified
201# scopes will look different, etc.
202
203OPTIMIZE_OUTPUT_JAVA = NO
204
205# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206# sources only. Doxygen will then generate output that is more tailored for
207# Fortran.
208
209OPTIMIZE_FOR_FORTRAN = NO
210
211# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212# sources. Doxygen will then generate output that is tailored for
213# VHDL.
214
215OPTIMIZE_OUTPUT_VHDL = NO
216
217# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218# to include (a tag file for) the STL sources as input, then you should
219# set this tag to YES in order to let doxygen match functions declarations and
220# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221# func(std::string) {}). This also make the inheritance and collaboration
222# diagrams that involve STL classes more complete and accurate.
223
224BUILTIN_STL_SUPPORT = NO
225
226# If you use Microsoft's C++/CLI language, you should set this option to YES to
227# enable parsing support.
228
229CPP_CLI_SUPPORT = NO
230
231# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232# Doxygen will parse them like normal C++ but will assume all classes use public
233# instead of private inheritance when no explicit protection keyword is present.
234
235SIP_SUPPORT = NO
236
237# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
238# tag is set to YES, then doxygen will reuse the documentation of the first
239# member in the group (if any) for the other members of the group. By default
240# all members of a group must be documented explicitly.
241
242DISTRIBUTE_GROUP_DOC = NO
243
244# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
245# the same type (for instance a group of public functions) to be put as a
246# subgroup of that type (e.g. under the Public Functions section). Set it to
247# NO to prevent subgrouping. Alternatively, this can be done per class using
248# the \nosubgrouping command.
249
250SUBGROUPING = YES
251
252# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
253# is documented as struct, union, or enum with the name of the typedef. So
254# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
255# with name TypeT. When disabled the typedef will appear as a member of a file,
256# namespace, or class. And the struct will be named TypeS. This can typically
257# be useful for C code in case the coding convention dictates that all compound
258# types are typedef'ed and only the typedef is referenced, never the tag name.
259
260TYPEDEF_HIDES_STRUCT = NO
261
262#---------------------------------------------------------------------------
263# Build related configuration options
264#---------------------------------------------------------------------------
265
266# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
267# documentation are documented, even if no documentation was available.
268# Private class members and static file members will be hidden unless
269# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
270
271EXTRACT_ALL = NO
272
273# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
274# will be included in the documentation.
275
276EXTRACT_PRIVATE = NO
277
278# If the EXTRACT_STATIC tag is set to YES all static members of a file
279# will be included in the documentation.
280
281EXTRACT_STATIC = YES
282
283# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
284# defined locally in source files will be included in the documentation.
285# If set to NO only classes defined in header files are included.
286
287EXTRACT_LOCAL_CLASSES = NO
288
289# This flag is only useful for Objective-C code. When set to YES local
290# methods, which are defined in the implementation section but not in
291# the interface are included in the documentation.
292# If set to NO (the default) only methods in the interface are included.
293
294EXTRACT_LOCAL_METHODS = NO
295
296# If this flag is set to YES, the members of anonymous namespaces will be
297# extracted and appear in the documentation as a namespace called
298# 'anonymous_namespace{file}', where file will be replaced with the base
299# name of the file that contains the anonymous namespace. By default
300# anonymous namespace are hidden.
301
302EXTRACT_ANON_NSPACES = NO
303
304# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
305# undocumented members of documented classes, files or namespaces.
306# If set to NO (the default) these members will be included in the
307# various overviews, but no documentation section is generated.
308# This option has no effect if EXTRACT_ALL is enabled.
309
310HIDE_UNDOC_MEMBERS = NO
311
312# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
313# undocumented classes that are normally visible in the class hierarchy.
314# If set to NO (the default) these classes will be included in the various
315# overviews. This option has no effect if EXTRACT_ALL is enabled.
316
317HIDE_UNDOC_CLASSES = NO
318
319# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
320# friend (class|struct|union) declarations.
321# If set to NO (the default) these declarations will be included in the
322# documentation.
323
324HIDE_FRIEND_COMPOUNDS = NO
325
326# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
327# documentation blocks found inside the body of a function.
328# If set to NO (the default) these blocks will be appended to the
329# function's detailed documentation block.
330
331HIDE_IN_BODY_DOCS = NO
332
333# The INTERNAL_DOCS tag determines if documentation
334# that is typed after a \internal command is included. If the tag is set
335# to NO (the default) then the documentation will be excluded.
336# Set it to YES to include the internal documentation.
337
338INTERNAL_DOCS = NO
339
340# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
341# file names in lower-case letters. If set to YES upper-case letters are also
342# allowed. This is useful if you have classes or files whose names only differ
343# in case and if your file system supports case sensitive file names. Windows
344# and Mac users are advised to set this option to NO.
345
346CASE_SENSE_NAMES = YES
347
348# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
349# will show members with their full class and namespace scopes in the
350# documentation. If set to YES the scope will be hidden.
351
352HIDE_SCOPE_NAMES = NO
353
354# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
355# will put a list of the files that are included by a file in the documentation
356# of that file.
357
358SHOW_INCLUDE_FILES = NO
359
360# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
361# is inserted in the documentation for inline members.
362
363INLINE_INFO = YES
364
365# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
366# will sort the (detailed) documentation of file and class members
367# alphabetically by member name. If set to NO the members will appear in
368# declaration order.
369
370SORT_MEMBER_DOCS = NO
371
372# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
373# brief documentation of file, namespace and class members alphabetically
374# by member name. If set to NO (the default) the members will appear in
375# declaration order.
376
377SORT_BRIEF_DOCS = NO
378
379# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
380# hierarchy of group names into alphabetical order. If set to NO (the default)
381# the group names will appear in their defined order.
382
383SORT_GROUP_NAMES = NO
384
385# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
386# sorted by fully-qualified names, including namespaces. If set to
387# NO (the default), the class list will be sorted only by class name,
388# not including the namespace part.
389# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
390# Note: This option applies only to the class list, not to the
391# alphabetical list.
392
393SORT_BY_SCOPE_NAME = NO
394
395# The GENERATE_TODOLIST tag can be used to enable (YES) or
396# disable (NO) the todo list. This list is created by putting \todo
397# commands in the documentation.
398
399GENERATE_TODOLIST = YES
400
401# The GENERATE_TESTLIST tag can be used to enable (YES) or
402# disable (NO) the test list. This list is created by putting \test
403# commands in the documentation.
404
405GENERATE_TESTLIST = YES
406
407# The GENERATE_BUGLIST tag can be used to enable (YES) or
408# disable (NO) the bug list. This list is created by putting \bug
409# commands in the documentation.
410
411GENERATE_BUGLIST = YES
412
413# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
414# disable (NO) the deprecated list. This list is created by putting
415# \deprecated commands in the documentation.
416
417GENERATE_DEPRECATEDLIST= YES
418
419# The ENABLED_SECTIONS tag can be used to enable conditional
420# documentation sections, marked by \if sectionname ... \endif.
421
422ENABLED_SECTIONS =
423
424# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
425# the initial value of a variable or define consists of for it to appear in
426# the documentation. If the initializer consists of more lines than specified
427# here it will be hidden. Use a value of 0 to hide initializers completely.
428# The appearance of the initializer of individual variables and defines in the
429# documentation can be controlled using \showinitializer or \hideinitializer
430# command in the documentation regardless of this setting.
431
432MAX_INITIALIZER_LINES = 30
433
434# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
435# at the bottom of the documentation of classes and structs. If set to YES the
436# list will mention the files that were used to generate the documentation.
437
438SHOW_USED_FILES = NO
439
440# If the sources in your project are distributed over multiple directories
441# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
442# in the documentation. The default is NO.
443
444SHOW_DIRECTORIES = NO
445
446# The FILE_VERSION_FILTER tag can be used to specify a program or script that
447# doxygen should invoke to get the current version for each file (typically from
448# the version control system). Doxygen will invoke the program by executing (via
449# popen()) the command <command> <input-file>, where <command> is the value of
450# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
451# provided by doxygen. Whatever the program writes to standard output
452# is used as the file version. See the manual for examples.
453
454FILE_VERSION_FILTER =
455
456#---------------------------------------------------------------------------
457# configuration options related to warning and progress messages
458#---------------------------------------------------------------------------
459
460# The QUIET tag can be used to turn on/off the messages that are generated
461# by doxygen. Possible values are YES and NO. If left blank NO is used.
462
463QUIET = NO
464
465# The WARNINGS tag can be used to turn on/off the warning messages that are
466# generated by doxygen. Possible values are YES and NO. If left blank
467# NO is used.
468
469WARNINGS = YES
470
471# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
472# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
473# automatically be disabled.
474
475WARN_IF_UNDOCUMENTED = YES
476
477# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
478# potential errors in the documentation, such as not documenting some
479# parameters in a documented function, or documenting parameters that
480# don't exist or using markup commands wrongly.
481
482WARN_IF_DOC_ERROR = YES
483
484# This WARN_NO_PARAMDOC option can be abled to get warnings for
485# functions that are documented, but have no documentation for their parameters
486# or return value. If set to NO (the default) doxygen will only warn about
487# wrong or incomplete parameter documentation, but not about the absence of
488# documentation.
489
490WARN_NO_PARAMDOC = YES
491
492# The WARN_FORMAT tag determines the format of the warning messages that
493# doxygen can produce. The string should contain the $file, $line, and $text
494# tags, which will be replaced by the file and line number from which the
495# warning originated and the warning text. Optionally the format may contain
496# $version, which will be replaced by the version of the file (if it could
497# be obtained via FILE_VERSION_FILTER)
498
499WARN_FORMAT = "$file:$line: $text"
500
501# The WARN_LOGFILE tag can be used to specify a file to which warning
502# and error messages should be written. If left blank the output is written
503# to stderr.
504
505WARN_LOGFILE =
506
507#---------------------------------------------------------------------------
508# configuration options related to the input files
509#---------------------------------------------------------------------------
510
511# The INPUT tag can be used to specify the files and/or directories that contain
512# documented source files. You may enter file names like "myfile.cpp" or
513# directories like "/usr/src/myproject". Separate the files or directories
514# with spaces.
515
516INPUT = ../src/lib
517
518# This tag can be used to specify the character encoding of the source files
519# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
520# also the default input encoding. Doxygen uses libiconv (or the iconv built
521# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
522# the list of possible encodings.
523
524INPUT_ENCODING = UTF-8
525
526# If the value of the INPUT tag contains directories, you can use the
527# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
528# and *.h) to filter out the source-files in the directories. If left
529# blank the following patterns are tested:
530# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
531# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
532
533FILE_PATTERNS = *.c *.h *.x
534
535# The RECURSIVE tag can be used to turn specify whether or not subdirectories
536# should be searched for input files as well. Possible values are YES and NO.
537# If left blank NO is used.
538
539RECURSIVE = YES
540
541# The EXCLUDE tag can be used to specify files and/or directories that should
542# excluded from the INPUT source files. This way you can easily exclude a
543# subdirectory from a directory tree whose root is specified with the INPUT tag.
544
545EXCLUDE =
546
547# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
548# directories that are symbolic links (a Unix filesystem feature) are excluded
549# from the input.
550
551EXCLUDE_SYMLINKS = NO
552
553# If the value of the INPUT tag contains directories, you can use the
554# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
555# certain files from those directories. Note that the wildcards are matched
556# against the file with absolute path, so to exclude all test directories
557# for example use the pattern */test/*
558
559EXCLUDE_PATTERNS =
560
561# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
562# (namespaces, classes, functions, etc.) that should be excluded from the
563# output. The symbol name can be a fully qualified name, a word, or if the
564# wildcard * is used, a substring. Examples: ANamespace, AClass,
565# AClass::ANamespace, ANamespace::*Test
566
567EXCLUDE_SYMBOLS =
568
569# The EXAMPLE_PATH tag can be used to specify one or more files or
570# directories that contain example code fragments that are included (see
571# the \include command).
572
573EXAMPLE_PATH =
574
575# If the value of the EXAMPLE_PATH tag contains directories, you can use the
576# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
577# and *.h) to filter out the source-files in the directories. If left
578# blank all files are included.
579
580EXAMPLE_PATTERNS =
581
582# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
583# searched for input files to be used with the \include or \dontinclude
584# commands irrespective of the value of the RECURSIVE tag.
585# Possible values are YES and NO. If left blank NO is used.
586
587EXAMPLE_RECURSIVE = NO
588
589# The IMAGE_PATH tag can be used to specify one or more files or
590# directories that contain image that are included in the documentation (see
591# the \image command).
592
593IMAGE_PATH = doc/img
594
595# The INPUT_FILTER tag can be used to specify a program that doxygen should
596# invoke to filter for each input file. Doxygen will invoke the filter program
597# by executing (via popen()) the command <filter> <input-file>, where <filter>
598# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
599# input file. Doxygen will then use the output that the filter program writes
600# to standard output. If FILTER_PATTERNS is specified, this tag will be
601# ignored.
602
603INPUT_FILTER =
604
605# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
606# basis. Doxygen will compare the file name with each pattern and apply the
607# filter if there is a match. The filters are a list of the form:
608# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
609# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
610# is applied to all files.
611
612FILTER_PATTERNS =
613
614# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
615# INPUT_FILTER) will be used to filter the input files when producing source
616# files to browse (i.e. when SOURCE_BROWSER is set to YES).
617
618FILTER_SOURCE_FILES = NO
619
620#---------------------------------------------------------------------------
621# configuration options related to source browsing
622#---------------------------------------------------------------------------
623
624# If the SOURCE_BROWSER tag is set to YES then a list of source files will
625# be generated. Documented entities will be cross-referenced with these sources.
626# Note: To get rid of all source code in the generated output, make sure also
627# VERBATIM_HEADERS is set to NO.
628
629SOURCE_BROWSER = NO
630
631# Setting the INLINE_SOURCES tag to YES will include the body
632# of functions and classes directly in the documentation.
633
634INLINE_SOURCES = NO
635
636# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
637# doxygen to hide any special comment blocks from generated source code
638# fragments. Normal C and C++ comments will always remain visible.
639
640STRIP_CODE_COMMENTS = YES
641
642# If the REFERENCED_BY_RELATION tag is set to YES (the default)
643# then for each documented function all documented
644# functions referencing it will be listed.
645
646REFERENCED_BY_RELATION = YES
647
648# If the REFERENCES_RELATION tag is set to YES (the default)
649# then for each documented function all documented entities
650# called/used by that function will be listed.
651
652REFERENCES_RELATION = YES
653
654# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
655# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
656# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
657# link to the source code. Otherwise they will link to the documentstion.
658
659REFERENCES_LINK_SOURCE = YES
660
661# If the USE_HTAGS tag is set to YES then the references to source code
662# will point to the HTML generated by the htags(1) tool instead of doxygen
663# built-in source browser. The htags tool is part of GNU's global source
664# tagging system (see http://www.gnu.org/software/global/global.html). You
665# will need version 4.8.6 or higher.
666
667USE_HTAGS = NO
668
669# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
670# will generate a verbatim copy of the header file for each class for
671# which an include is specified. Set to NO to disable this.
672
673VERBATIM_HEADERS = NO
674
675#---------------------------------------------------------------------------
676# configuration options related to the alphabetical class index
677#---------------------------------------------------------------------------
678
679# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
680# of all compounds will be generated. Enable this if the project
681# contains a lot of classes, structs, unions or interfaces.
682
683ALPHABETICAL_INDEX = YES
684
685# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
686# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
687# in which this list will be split (can be a number in the range [1..20])
688
689COLS_IN_ALPHA_INDEX = 2
690
691# In case all classes in a project start with a common prefix, all
692# classes will be put under the same header in the alphabetical index.
693# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
694# should be ignored while generating the index headers.
695
696IGNORE_PREFIX =
697
698#---------------------------------------------------------------------------
699# configuration options related to the HTML output
700#---------------------------------------------------------------------------
701
702# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
703# generate HTML output.
704
705GENERATE_HTML = YES
706
707# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
708# If a relative path is entered the value of OUTPUT_DIRECTORY will be
709# put in front of it. If left blank `html' will be used as the default path.
710
711HTML_OUTPUT = html
712
713# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
714# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
715# doxygen will generate files with .html extension.
716
717HTML_FILE_EXTENSION = .html
718
719# The HTML_HEADER tag can be used to specify a personal HTML header for
720# each generated HTML page. If it is left blank doxygen will generate a
721# standard header.
722
723HTML_HEADER = head.html
724
725# The HTML_FOOTER tag can be used to specify a personal HTML footer for
726# each generated HTML page. If it is left blank doxygen will generate a
727# standard footer.
728
729HTML_FOOTER = foot.html
730
731# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
732# style sheet that is used by each HTML page. It can be used to
733# fine-tune the look of the HTML output. If the tag is left blank doxygen
734# will generate a default style sheet. Note that doxygen will try to copy
735# the style sheet file to the HTML output directory, so don't put your own
736# stylesheet in the HTML output directory as well, or it will be erased!
737
738HTML_STYLESHEET = e.css
739
740# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
741# files or namespaces will be aligned in HTML using tables. If set to
742# NO a bullet list will be used.
743
744HTML_ALIGN_MEMBERS = YES
745
746# If the GENERATE_HTMLHELP tag is set to YES, additional index files
747# will be generated that can be used as input for tools like the
748# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
749# of the generated HTML documentation.
750
751GENERATE_HTMLHELP = NO
752
753# If the GENERATE_DOCSET tag is set to YES, additional index files
754# will be generated that can be used as input for Apple's Xcode 3
755# integrated development environment, introduced with OSX 10.5 (Leopard).
756# To create a documentation set, doxygen will generate a Makefile in the
757# HTML output directory. Running make will produce the docset in that
758# directory and running "make install" will install the docset in
759# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
760# it at startup.
761
762GENERATE_DOCSET = NO
763
764# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
765# feed. A documentation feed provides an umbrella under which multiple
766# documentation sets from a single provider (such as a company or product suite)
767# can be grouped.
768
769DOCSET_FEEDNAME = "Doxygen generated docs"
770
771# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
772# should uniquely identify the documentation set bundle. This should be a
773# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
774# will append .docset to the name.
775
776DOCSET_BUNDLE_ID = org.doxygen.Project
777
778# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
779# documentation will contain sections that can be hidden and shown after the
780# page has loaded. For this to work a browser that supports
781# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
782# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
783
784HTML_DYNAMIC_SECTIONS = NO
785
786# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
787# be used to specify the file name of the resulting .chm file. You
788# can add a path in front of the file if the result should not be
789# written to the html output directory.
790
791CHM_FILE =
792
793# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
794# be used to specify the location (absolute path including file name) of
795# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
796# the HTML help compiler on the generated index.hhp.
797
798HHC_LOCATION =
799
800# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
801# controls if a separate .chi index file is generated (YES) or that
802# it should be included in the master .chm file (NO).
803
804GENERATE_CHI = NO
805
806# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
807# controls whether a binary table of contents is generated (YES) or a
808# normal table of contents (NO) in the .chm file.
809
810BINARY_TOC = NO
811
812# The TOC_EXPAND flag can be set to YES to add extra items for group members
813# to the contents of the HTML help documentation and to the tree view.
814
815TOC_EXPAND = NO
816
817# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
818# top of each HTML page. The value NO (the default) enables the index and
819# the value YES disables it.
820
821DISABLE_INDEX = YES
822
823# This tag can be used to set the number of enum values (range [1..20])
824# that doxygen will group on one line in the generated HTML documentation.
825
826ENUM_VALUES_PER_LINE = 1
827
828# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
829# generated containing a tree-like index structure (just like the one that
830# is generated for HTML Help). For this to work a browser that supports
831# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
832# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
833# probably better off using the HTML help feature.
834
835GENERATE_TREEVIEW = NO
836
837# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
838# used to set the initial width (in pixels) of the frame in which the tree
839# is shown.
840
841TREEVIEW_WIDTH = 250
842
843#---------------------------------------------------------------------------
844# configuration options related to the LaTeX output
845#---------------------------------------------------------------------------
846
847# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
848# generate Latex output.
849
850GENERATE_LATEX = YES
851
852# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
853# If a relative path is entered the value of OUTPUT_DIRECTORY will be
854# put in front of it. If left blank `latex' will be used as the default path.
855
856LATEX_OUTPUT = latex
857
858# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
859# invoked. If left blank `latex' will be used as the default command name.
860
861LATEX_CMD_NAME = latex
862
863# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
864# generate index for LaTeX. If left blank `makeindex' will be used as the
865# default command name.
866
867MAKEINDEX_CMD_NAME = makeindex
868
869# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
870# LaTeX documents. This may be useful for small projects and may help to
871# save some trees in general.
872
873COMPACT_LATEX = NO
874
875# The PAPER_TYPE tag can be used to set the paper type that is used
876# by the printer. Possible values are: a4, a4wide, letter, legal and
877# executive. If left blank a4wide will be used.
878
879PAPER_TYPE = a4wide
880
881# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
882# packages that should be included in the LaTeX output.
883
884EXTRA_PACKAGES =
885
886# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
887# the generated latex document. The header should contain everything until
888# the first chapter. If it is left blank doxygen will generate a
889# standard header. Notice: only use this tag if you know what you are doing!
890
891LATEX_HEADER =
892
893# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
894# is prepared for conversion to pdf (using ps2pdf). The pdf file will
895# contain links (just like the HTML output) instead of page references
896# This makes the output suitable for online browsing using a pdf viewer.
897
898PDF_HYPERLINKS = YES
899
900# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
901# plain latex in the generated Makefile. Set this option to YES to get a
902# higher quality PDF documentation.
903
904USE_PDFLATEX = NO
905
906# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
907# command to the generated LaTeX files. This will instruct LaTeX to keep
908# running if errors occur, instead of asking the user for help.
909# This option is also used when generating formulas in HTML.
910
911LATEX_BATCHMODE = NO
912
913# If LATEX_HIDE_INDICES is set to YES then doxygen will not
914# include the index chapters (such as File Index, Compound Index, etc.)
915# in the output.
916
917LATEX_HIDE_INDICES = NO
918
919#---------------------------------------------------------------------------
920# configuration options related to the RTF output
921#---------------------------------------------------------------------------
922
923# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
924# The RTF output is optimized for Word 97 and may not look very pretty with
925# other RTF readers or editors.
926
927GENERATE_RTF = NO
928
929# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
930# If a relative path is entered the value of OUTPUT_DIRECTORY will be
931# put in front of it. If left blank `rtf' will be used as the default path.
932
933RTF_OUTPUT = rtf
934
935# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
936# RTF documents. This may be useful for small projects and may help to
937# save some trees in general.
938
939COMPACT_RTF = NO
940
941# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
942# will contain hyperlink fields. The RTF file will
943# contain links (just like the HTML output) instead of page references.
944# This makes the output suitable for online browsing using WORD or other
945# programs which support those fields.
946# Note: wordpad (write) and others do not support links.
947
948RTF_HYPERLINKS = NO
949
950# Load stylesheet definitions from file. Syntax is similar to doxygen's
951# config file, i.e. a series of assignments. You only have to provide
952# replacements, missing definitions are set to their default value.
953
954RTF_STYLESHEET_FILE =
955
956# Set optional variables used in the generation of an rtf document.
957# Syntax is similar to doxygen's config file.
958
959RTF_EXTENSIONS_FILE =
960
961#---------------------------------------------------------------------------
962# configuration options related to the man page output
963#---------------------------------------------------------------------------
964
965# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
966# generate man pages
967
968GENERATE_MAN = YES
969
970# The MAN_OUTPUT tag is used to specify where the man pages will be put.
971# If a relative path is entered the value of OUTPUT_DIRECTORY will be
972# put in front of it. If left blank `man' will be used as the default path.
973
974MAN_OUTPUT = man
975
976# The MAN_EXTENSION tag determines the extension that is added to
977# the generated man pages (default is the subroutine's section .3)
978
979MAN_EXTENSION = .3
980
981# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
982# then it will generate one additional man file for each entity
983# documented in the real man page(s). These additional files
984# only source the real man page, but without them the man command
985# would be unable to find the correct page. The default is NO.
986
987MAN_LINKS = YES
988
989#---------------------------------------------------------------------------
990# configuration options related to the XML output
991#---------------------------------------------------------------------------
992
993# If the GENERATE_XML tag is set to YES Doxygen will
994# generate an XML file that captures the structure of
995# the code including all documentation.
996
997GENERATE_XML = NO
998
999# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1000# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1001# put in front of it. If left blank `xml' will be used as the default path.
1002
1003XML_OUTPUT = xml
1004
1005# The XML_SCHEMA tag can be used to specify an XML schema,
1006# which can be used by a validating XML parser to check the
1007# syntax of the XML files.
1008
1009XML_SCHEMA =
1010
1011# The XML_DTD tag can be used to specify an XML DTD,
1012# which can be used by a validating XML parser to check the
1013# syntax of the XML files.
1014
1015XML_DTD =
1016
1017# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1018# dump the program listings (including syntax highlighting
1019# and cross-referencing information) to the XML output. Note that
1020# enabling this will significantly increase the size of the XML output.
1021
1022XML_PROGRAMLISTING = YES
1023
1024#---------------------------------------------------------------------------
1025# configuration options for the AutoGen Definitions output
1026#---------------------------------------------------------------------------
1027
1028# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1029# generate an AutoGen Definitions (see autogen.sf.net) file
1030# that captures the structure of the code including all
1031# documentation. Note that this feature is still experimental
1032# and incomplete at the moment.
1033
1034GENERATE_AUTOGEN_DEF = NO
1035
1036#---------------------------------------------------------------------------
1037# configuration options related to the Perl module output
1038#---------------------------------------------------------------------------
1039
1040# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1041# generate a Perl module file that captures the structure of
1042# the code including all documentation. Note that this
1043# feature is still experimental and incomplete at the
1044# moment.
1045
1046GENERATE_PERLMOD = NO
1047
1048# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1049# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1050# to generate PDF and DVI output from the Perl module output.
1051
1052PERLMOD_LATEX = NO
1053
1054# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1055# nicely formatted so it can be parsed by a human reader. This is useful
1056# if you want to understand what is going on. On the other hand, if this
1057# tag is set to NO the size of the Perl module output will be much smaller
1058# and Perl will parse it just the same.
1059
1060PERLMOD_PRETTY = YES
1061
1062# The names of the make variables in the generated doxyrules.make file
1063# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1064# This is useful so different doxyrules.make files included by the same
1065# Makefile don't overwrite each other's variables.
1066
1067PERLMOD_MAKEVAR_PREFIX =
1068
1069#---------------------------------------------------------------------------
1070# Configuration options related to the preprocessor
1071#---------------------------------------------------------------------------
1072
1073# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1074# evaluate all C-preprocessor directives found in the sources and include
1075# files.
1076
1077ENABLE_PREPROCESSING = YES
1078
1079# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1080# names in the source code. If set to NO (the default) only conditional
1081# compilation will be performed. Macro expansion can be done in a controlled
1082# way by setting EXPAND_ONLY_PREDEF to YES.
1083
1084MACRO_EXPANSION = YES
1085
1086# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1087# then the macro expansion is limited to the macros specified with the
1088# PREDEFINED and EXPAND_AS_DEFINED tags.
1089
1090EXPAND_ONLY_PREDEF = YES
1091
1092# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1093# in the INCLUDE_PATH (see below) will be search if a #include is found.
1094
1095SEARCH_INCLUDES = NO
1096
1097# The INCLUDE_PATH tag can be used to specify one or more directories that
1098# contain include files that are not input files but should be processed by
1099# the preprocessor.
1100
1101INCLUDE_PATH =
1102
1103# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1104# patterns (like *.h and *.hpp) to filter out the header-files in the
1105# directories. If left blank, the patterns specified with FILE_PATTERNS will
1106# be used.
1107
1108INCLUDE_FILE_PATTERNS =
1109
1110# The PREDEFINED tag can be used to specify one or more macro names that
1111# are defined before the preprocessor is started (similar to the -D option of
1112# gcc). The argument of the tag is a list of macros of the form: name
1113# or name=definition (no spaces). If the definition and the = are
1114# omitted =1 is assumed. To prevent a macro definition from being
1115# undefined via #undef or recursively expanded use the := operator
1116# instead of the = operator.
1117
1118PREDEFINED = __UNUSED__=
1119
1120# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1121# this tag can be used to specify a list of macro names that should be expanded.
1122# The macro definition that is found in the sources will be used.
1123# Use the PREDEFINED tag if you want to use a different macro definition.
1124
1125EXPAND_AS_DEFINED =
1126
1127# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1128# doxygen's preprocessor will remove all function-like macros that are alone
1129# on a line, have an all uppercase name, and do not end with a semicolon. Such
1130# function macros are typically used for boiler-plate code, and will confuse
1131# the parser if not removed.
1132
1133SKIP_FUNCTION_MACROS = YES
1134
1135#---------------------------------------------------------------------------
1136# Configuration::additions related to external references
1137#---------------------------------------------------------------------------
1138
1139# The TAGFILES option can be used to specify one or more tagfiles.
1140# Optionally an initial location of the external documentation
1141# can be added for each tagfile. The format of a tag file without
1142# this location is as follows:
1143# TAGFILES = file1 file2 ...
1144# Adding location for the tag files is done as follows:
1145# TAGFILES = file1=loc1 "file2 = loc2" ...
1146# where "loc1" and "loc2" can be relative or absolute paths or
1147# URLs. If a location is present for each tag, the installdox tool
1148# does not have to be run to correct the links.
1149# Note that each tag file must have a unique name
1150# (where the name does NOT include the path)
1151# If a tag file is not located in the directory in which doxygen
1152# is run, you must also specify the path to the tagfile here.
1153
1154TAGFILES =
1155
1156# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1157# a tag file that is based on the input files it reads.
1158
1159GENERATE_TAGFILE =
1160
1161# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1162# in the class index. If set to NO only the inherited external classes
1163# will be listed.
1164
1165ALLEXTERNALS = NO
1166
1167# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1168# in the modules index. If set to NO, only the current project's groups will
1169# be listed.
1170
1171EXTERNAL_GROUPS = YES
1172
1173# The PERL_PATH should be the absolute path and name of the perl script
1174# interpreter (i.e. the result of `which perl').
1175
1176PERL_PATH = /usr/bin/perl
1177
1178#---------------------------------------------------------------------------
1179# Configuration options related to the dot tool
1180#---------------------------------------------------------------------------
1181
1182# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1183# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1184# or super classes. Setting the tag to NO turns the diagrams off. Note that
1185# this option is superseded by the HAVE_DOT option below. This is only a
1186# fallback. It is recommended to install and use dot, since it yields more
1187# powerful graphs.
1188
1189CLASS_DIAGRAMS = NO
1190
1191# You can define message sequence charts within doxygen comments using the \msc
1192# command. Doxygen will then run the mscgen tool (see
1193# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1194# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1195# the mscgen tool resides. If left empty the tool is assumed to be found in the
1196# default search path.
1197
1198MSCGEN_PATH =
1199
1200# If set to YES, the inheritance and collaboration graphs will hide
1201# inheritance and usage relations if the target is undocumented
1202# or is not a class.
1203
1204HIDE_UNDOC_RELATIONS = YES
1205
1206# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1207# available from the path. This tool is part of Graphviz, a graph visualization
1208# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1209# have no effect if this option is set to NO (the default)
1210
1211HAVE_DOT = NO
1212
1213# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1214# will generate a graph for each documented class showing the direct and
1215# indirect inheritance relations. Setting this tag to YES will force the
1216# the CLASS_DIAGRAMS tag to NO.
1217
1218CLASS_GRAPH = NO
1219
1220# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1221# will generate a graph for each documented class showing the direct and
1222# indirect implementation dependencies (inheritance, containment, and
1223# class references variables) of the class with other documented classes.
1224
1225COLLABORATION_GRAPH = NO
1226
1227# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1228# will generate a graph for groups, showing the direct groups dependencies
1229
1230GROUP_GRAPHS = YES
1231
1232# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1233# collaboration diagrams in a style similar to the OMG's Unified Modeling
1234# Language.
1235
1236UML_LOOK = NO
1237
1238# If set to YES, the inheritance and collaboration graphs will show the
1239# relations between templates and their instances.
1240
1241TEMPLATE_RELATIONS = NO
1242
1243# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1244# tags are set to YES then doxygen will generate a graph for each documented
1245# file showing the direct and indirect include dependencies of the file with
1246# other documented files.
1247
1248INCLUDE_GRAPH = NO
1249
1250# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1251# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1252# documented header file showing the documented files that directly or
1253# indirectly include this file.
1254
1255INCLUDED_BY_GRAPH = NO
1256
1257# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1258# doxygen will generate a call dependency graph for every global function
1259# or class method. Note that enabling this option will significantly increase
1260# the time of a run. So in most cases it will be better to enable call graphs
1261# for selected functions only using the \callgraph command.
1262
1263CALL_GRAPH = NO
1264
1265# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1266# doxygen will generate a caller dependency graph for every global function
1267# or class method. Note that enabling this option will significantly increase
1268# the time of a run. So in most cases it will be better to enable caller
1269# graphs for selected functions only using the \callergraph command.
1270
1271CALLER_GRAPH = NO
1272
1273# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1274# will graphical hierarchy of all classes instead of a textual one.
1275
1276GRAPHICAL_HIERARCHY = NO
1277
1278# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1279# then doxygen will show the dependencies a directory has on other directories
1280# in a graphical way. The dependency relations are determined by the #include
1281# relations between the files in the directories.
1282
1283DIRECTORY_GRAPH = YES
1284
1285# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1286# generated by dot. Possible values are png, jpg, or gif
1287# If left blank png will be used.
1288
1289DOT_IMAGE_FORMAT = png
1290
1291# The tag DOT_PATH can be used to specify the path where the dot tool can be
1292# found. If left blank, it is assumed the dot tool can be found in the path.
1293
1294DOT_PATH =
1295
1296# The DOTFILE_DIRS tag can be used to specify one or more directories that
1297# contain dot files that are included in the documentation (see the
1298# \dotfile command).
1299
1300DOTFILE_DIRS =
1301
1302# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1303# nodes that will be shown in the graph. If the number of nodes in a graph
1304# becomes larger than this value, doxygen will truncate the graph, which is
1305# visualized by representing a node as a red box. Note that doxygen if the
1306# number of direct children of the root node in a graph is already larger than
1307# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1308# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1309
1310DOT_GRAPH_MAX_NODES = 50
1311
1312# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1313# graphs generated by dot. A depth value of 3 means that only nodes reachable
1314# from the root by following a path via at most 3 edges will be shown. Nodes
1315# that lay further from the root node will be omitted. Note that setting this
1316# option to 1 or 2 may greatly reduce the computation time needed for large
1317# code bases. Also note that the size of a graph can be further restricted by
1318# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1319
1320MAX_DOT_GRAPH_DEPTH = 0
1321
1322# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1323# background. This is enabled by default, which results in a transparent
1324# background. Warning: Depending on the platform used, enabling this option
1325# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1326# become hard to read).
1327
1328DOT_TRANSPARENT = YES
1329
1330# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1331# files in one run (i.e. multiple -o and -T options on the command line). This
1332# makes dot run faster, but since only newer versions of dot (>1.8.10)
1333# support this, this feature is disabled by default.
1334
1335DOT_MULTI_TARGETS = NO
1336
1337# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1338# generate a legend page explaining the meaning of the various boxes and
1339# arrows in the dot generated graphs.
1340
1341GENERATE_LEGEND = YES
1342
1343# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1344# remove the intermediate dot files that are used to generate
1345# the various graphs.
1346
1347DOT_CLEANUP = YES
1348
1349#---------------------------------------------------------------------------
1350# Configuration::additions related to the search engine
1351#---------------------------------------------------------------------------
1352
1353# The SEARCHENGINE tag specifies whether or not a search engine should be
1354# used. If set to NO the values of all tags below this one will be ignored.
1355
1356SEARCHENGINE = NO
diff --git a/legacy/ethumb/doc/Makefile.am b/legacy/ethumb/doc/Makefile.am
new file mode 100644
index 0000000000..ff2628cbe0
--- /dev/null
+++ b/legacy/ethumb/doc/Makefile.am
@@ -0,0 +1,23 @@
1
2MAINTAINERCLEANFILES = Makefile.in
3
4.PHONY: doc
5
6if EFL_BUILD_DOC
7
8doc: all
9 rm -rf html/ latex/ man/
10 $(efl_doxygen)
11 cp img/* html/
12
13else
14
15doc:
16 @echo "Documentation not built. Run ./configure --help"
17
18endif
19
20clean-local:
21 @rm -rf html/ latex/ man/
22
23EXTRA_DIST = Doxyfile $(wildcard img/*.*) e.css head.html foot.html
diff --git a/legacy/ethumb/doc/e.css b/legacy/ethumb/doc/e.css
new file mode 100644
index 0000000000..8697a3a0be
--- /dev/null
+++ b/legacy/ethumb/doc/e.css
@@ -0,0 +1,218 @@
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#header {
65 width: 100%;
66 height: 102px;
67}
68
69#header h1 {
70 width: 63px;
71 height: 63px;
72 background-image: url(e.png);
73 background-repeat: no-repeat;
74 position: absolute;
75 margin: 0px;
76}
77
78#header h1 span {
79 display: none;
80}
81
82#header h2 {
83 display: none;
84}
85
86/* .menu-container is used to set properties common to .menu and .submenu */
87#header .menu-container {
88}
89
90#header .menu-container ul {
91 list-style-type: none;
92 list-style-position: inside;
93 margin: 0;
94}
95
96#header .menu-container li {
97 display: block;
98 float: right;
99}
100
101#header .menu {
102 height: 63px;
103 display: block;
104 background-image: url(menu_bg.png);
105 background-repeat: repeat-x;
106}
107
108#header .menu ul {
109 height: 100%;
110 display: block;
111 background-image: url(menu_bg_last.png);
112 background-repeat: no-repeat;
113 background-position: top right;
114 padding-right: 17px;
115}
116
117#header .menu li {
118 height: 100%;
119 text-align: center;
120 background-image: url(menu_bg_unsel.png);
121 background-repeat: no-repeat;
122}
123
124#header .menu a {
125 height: 100%;
126 display: block;
127 color: #cdcdcd;
128 text-decoration: none;
129 font-size: 10pt;
130 line-height: 59px;
131 text-align: center;
132 padding: 0px 15px 0px 15px;
133}
134
135#header .menu li:hover {
136 background-image: url(menu_bg_hover.png);
137 background-repeat: no-repeat;
138}
139
140#header .menu li:hover a {
141 color: #FFFFFF;
142}
143
144#header .menu li.current {
145 background-image: url(menu_bg_current.png);
146 background-repeat: no-repeat;
147}
148
149#header .menu li.current a {
150 color: #646464;
151}
152
153
154/* Hide all the submenus but the current */
155#header .submenu ul {
156 display: none;
157}
158
159#header .submenu .current {
160 display: block;
161}
162
163#header .submenu {
164 font: bold 10px verdana,'Bitstream Vera Sans',helvetica,arial,sans-serif;
165 margin-top: 10px;
166}
167
168#header .submenu a {
169 color: #888888;
170 text-decoration: none;
171 font-size: 0.9em;
172 line-height: 15px;
173 padding:0px 5px 0px 5px;
174}
175
176#header .submenu a:hover {
177 color: #444444;
178}
179
180#header .submenu li {
181 border-left: 1px solid #DDDDDD;
182}
183
184#header .submenu li:last-child {
185 border-left: 0;
186}
187
188#header .doxytitle {
189 position: absolute;
190 font-size: 1.8em;
191 font-weight: bold;
192 color: #444444;
193 line-height: 35px;
194}
195
196#header small {
197 font-size: 0.4em;
198}
199
200#footer {
201 background-image: url(foot_bg.png);
202 width: 100%;
203}
204
205#footer table {
206 width: 100%;
207 text-align: center;
208 white-space: nowrap;
209 padding: 5px 30px 5px 30px;
210 font-size: 0.8em;
211 font-family: "Bitstream Vera","Vera","Trebuchet MS",Trebuchet,Tahoma,sans-serif;
212 color: #888888;
213}
214
215#footer td.copyright {
216 width: 100%;
217}
218
diff --git a/legacy/ethumb/doc/foot.html b/legacy/ethumb/doc/foot.html
new file mode 100644
index 0000000000..78ef911c72
--- /dev/null
+++ b/legacy/ethumb/doc/foot.html
@@ -0,0 +1,19 @@
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 class="copyright">Copyright &copy;$year Enlightenment</td>
13 <td class="generated">Docs generated $datetime</td>
14 </tr></table>
15 </div>
16
17
18</body>
19</html>
diff --git a/legacy/ethumb/doc/head.html b/legacy/ethumb/doc/head.html
new file mode 100644
index 0000000000..44a5551dbe
--- /dev/null
+++ b/legacy/ethumb/doc/head.html
@@ -0,0 +1,64 @@
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" media="screen" href="e.css">
13 <link rel="stylesheet" type="text/css" media="screen" 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 <div class="menu-container">
27 <div class="menu">
28 <ul>
29 <li class="current"><a href="http://web.enlightenment.org/p.php?p=docs">Docs</a></li>
30 <li><a href="http://trac.enlightenment.org/e">Tracker</a></li>
31 <li><a href="http://www.enlightenment.org/p.php?p=contact">Contact</a></li>
32 <li><a href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></li>
33 <li><a href="http://www.enlightenment.org/p.php?p=support">Support</a></li>
34 <li><a href="http://www.enlightenment.org/p.php?p=download">Download</a></li>
35 <li><a href="http://www.enlightenment.org/p.php?p=about">About</a></li>
36 <li><a href="http://www.enlightenment.org/p.php?p=news">News</a></li>
37 <li><a href="http://www.enlightenment.org/">Home</a></li>
38 </ul>
39 </div>
40 </div>
41
42 <div class="doxytitle">
43 $projectname Documentation <small>at $date</small>
44 </div>
45
46 <div class="menu-container">
47 <div class="submenu">
48 <ul class="current">
49 <li><a href="pages.html">Tutorials</a></li>
50<!-- <li><a href="globals.html">Globals</a></li>-->
51<!-- <li><a href="files.html">Files</a></li>-->
52 <li><a href="modules.html">Modules</a></li>
53 <li class="current"><a href="index.html">Main Page</a></li>
54 </ul>
55 </div>
56 </div>
57
58
59 <div class="clear"></div>
60</div>
61</div>
62
63<div id="content">
64<div class="layout">
diff --git a/legacy/ethumb/doc/img/e.png b/legacy/ethumb/doc/img/e.png
new file mode 100644
index 0000000000..b3884a5cbc
--- /dev/null
+++ b/legacy/ethumb/doc/img/e.png
Binary files differ
diff --git a/legacy/ethumb/doc/img/edoxy.css b/legacy/ethumb/doc/img/edoxy.css
new file mode 100644
index 0000000000..3caf7a9736
--- /dev/null
+++ b/legacy/ethumb/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/ethumb/doc/img/foot_bg.png b/legacy/ethumb/doc/img/foot_bg.png
new file mode 100644
index 0000000000..b24f3a48b4
--- /dev/null
+++ b/legacy/ethumb/doc/img/foot_bg.png
Binary files differ
diff --git a/legacy/ethumb/doc/img/head_bg.png b/legacy/ethumb/doc/img/head_bg.png
new file mode 100644
index 0000000000..081dc131e4
--- /dev/null
+++ b/legacy/ethumb/doc/img/head_bg.png
Binary files differ
diff --git a/legacy/ethumb/doc/img/menu_bg.png b/legacy/ethumb/doc/img/menu_bg.png
new file mode 100644
index 0000000000..e978743651
--- /dev/null
+++ b/legacy/ethumb/doc/img/menu_bg.png
Binary files differ
diff --git a/legacy/ethumb/doc/img/menu_bg_current.png b/legacy/ethumb/doc/img/menu_bg_current.png
new file mode 100644
index 0000000000..de97c9268e
--- /dev/null
+++ b/legacy/ethumb/doc/img/menu_bg_current.png
Binary files differ
diff --git a/legacy/ethumb/doc/img/menu_bg_hover.png b/legacy/ethumb/doc/img/menu_bg_hover.png
new file mode 100644
index 0000000000..3fd851d075
--- /dev/null
+++ b/legacy/ethumb/doc/img/menu_bg_hover.png
Binary files differ
diff --git a/legacy/ethumb/doc/img/menu_bg_last.png b/legacy/ethumb/doc/img/menu_bg_last.png
new file mode 100644
index 0000000000..88c116c8c8
--- /dev/null
+++ b/legacy/ethumb/doc/img/menu_bg_last.png
Binary files differ
diff --git a/legacy/ethumb/doc/img/menu_bg_unsel.png b/legacy/ethumb/doc/img/menu_bg_unsel.png
new file mode 100644
index 0000000000..50e5fd8d3d
--- /dev/null
+++ b/legacy/ethumb/doc/img/menu_bg_unsel.png
Binary files differ
diff --git a/legacy/ethumb/m4/Makefile.am b/legacy/ethumb/m4/Makefile.am
index be8ee32bd9..688b1e47a6 100644
--- a/legacy/ethumb/m4/Makefile.am
+++ b/legacy/ethumb/m4/Makefile.am
@@ -5,4 +5,5 @@ EXTRA_DIST = iconv.m4 \
5 lib-prefix.m4 \ 5 lib-prefix.m4 \
6 progtest.m4 \ 6 progtest.m4 \
7 as-expand.m4 \ 7 as-expand.m4 \
8 ac-modules.m4 8 ac-modules.m4 \
9 efl_doxygen.m4
diff --git a/legacy/ethumb/m4/efl_doxygen.m4 b/legacy/ethumb/m4/efl_doxygen.m4
new file mode 100644
index 0000000000..d83ed68b8a
--- /dev/null
+++ b/legacy/ethumb/m4/efl_doxygen.m4
@@ -0,0 +1,97 @@
1dnl Copyright (C) 2008 Vincent Torri <vtorri at univ-evry dot fr>
2dnl That code is public domain and can be freely used or copied.
3
4dnl Macro that check if doxygen is available or not.
5
6dnl EFL_CHECK_DOXYGEN([ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]])
7dnl Test for the doxygen program
8dnl Defines efl_doxygen
9dnl Defines the automake conditionnal EFL_BUILD_DOC
10dnl
11AC_DEFUN([EFL_CHECK_DOXYGEN],
12[
13
14dnl
15dnl Disable the build of the documentation
16dnl
17AC_ARG_ENABLE([doc],
18 [AC_HELP_STRING(
19 [--disable-doc],
20 [Disable documentation build @<:@default=enabled@:>@])],
21 [
22 if test "x${enableval}" = "xyes" ; then
23 efl_enable_doc="yes"
24 else
25 efl_enable_doc="no"
26 fi
27 ],
28 [efl_enable_doc="yes"])
29
30AC_MSG_CHECKING([whether to build documentation])
31AC_MSG_RESULT([${efl_enable_doc}])
32
33if test "x${efl_enable_doc}" = "xyes" ; then
34
35dnl Specify the file name, without path
36
37 efl_doxygen="doxygen"
38
39 AC_ARG_WITH([doxygen],
40 [AC_HELP_STRING(
41 [--with-doxygen=FILE],
42 [doxygen program to use @<:@default=doxygen@:>@])],
43
44dnl Check the given doxygen program.
45
46 [efl_doxygen=${withval}
47 AC_CHECK_PROG([efl_have_doxygen],
48 [${efl_doxygen}],
49 [yes],
50 [no])
51 if test "x${efl_have_doxygen}" = "xno" ; then
52 echo "WARNING:"
53 echo "The doxygen program you specified:"
54 echo "${efl_doxygen}"
55 echo "was not found. Please check the path and make sure "
56 echo "the program exists and is executable."
57 AC_MSG_WARN([no doxygen detected. Documentation will not be built])
58 fi
59 ],
60 [AC_CHECK_PROG([efl_have_doxygen],
61 [${efl_doxygen}],
62 [yes],
63 [no])
64 if test "x${efl_have_doxygen}" = "xno" ; then
65 echo "WARNING:"
66 echo "The doxygen program was not found in your execute path."
67 echo "You may have doxygen installed somewhere not covered by your path."
68 echo ""
69 echo "If this is the case make sure you have the packages installed, AND"
70 echo "that the doxygen program is in your execute path (see your"
71 echo "shell manual page on setting the \$PATH environment variable), OR"
72 echo "alternatively, specify the program to use with --with-doxygen."
73 AC_MSG_WARN([no doxygen detected. Documentation will not be built])
74 fi
75 ])
76fi
77
78dnl
79dnl Substitution
80dnl
81AC_SUBST([efl_doxygen])
82
83if ! test "x${efl_have_doxygen}" = "xyes" ; then
84 efl_enable_doc="no"
85fi
86
87AM_CONDITIONAL(EFL_BUILD_DOC, test "x${efl_enable_doc}" = "xyes")
88
89if test "x${efl_enable_doc}" = "xyes" ; then
90 m4_default([$1], [:])
91else
92 m4_default([$2], [:])
93fi
94
95])
96
97dnl End of efl_doxygen.m4
diff --git a/legacy/ethumb/src/lib/client/Ethumb_Client.c b/legacy/ethumb/src/lib/client/Ethumb_Client.c
index 998de52ea1..1ddd8d4f8f 100644
--- a/legacy/ethumb/src/lib/client/Ethumb_Client.c
+++ b/legacy/ethumb/src/lib/client/Ethumb_Client.c
@@ -1,6 +1,9 @@
1/** 1/**
2 * @file 2 * @file
3 * 3 *
4 * This is the client-server thumbnail library, see @ref
5 * tutorial_ethumb_client.
6 *
4 * Copyright (C) 2009 by ProFUSION embedded systems 7 * Copyright (C) 2009 by ProFUSION embedded systems
5 * 8 *
6 * This program is free software; you can redistribute it and/or modify it 9 * This program is free software; you can redistribute it and/or modify it
@@ -19,7 +22,46 @@
19 * USA. 22 * USA.
20 * 23 *
21 * @author Rafael Antognolli <antognolli@profusion.mobi> 24 * @author Rafael Antognolli <antognolli@profusion.mobi>
25 * @author Gustavo Sverzut Barbieri <barbieri@profusion.mobi>
26 */
27
28/**
29 * @page tutorial_ethumb_client Client-Server Thumbnailing Tutorial
30 *
31 * @section tutorial_ethumb_client_intro Introduction
32 *
33 * Ethumb provides both in process and client-server generation
34 * methods. The advantage of the client-server method is that current
35 * process will not do the heavy operations that may block, stopping
36 * animations and other user interactions. Instead the client library
37 * will configure a local #Ethumb instance and mirrors/controls a
38 * remote process using DBus. The simple operations like most setters
39 * and getters as well as checking for thumbnail existence
40 * (ethumb_client_thumb_exists()) is done locally, while expensive
41 * (ethumb_client_generate()) are done on server and then reported
42 * back to application when it is finished (both success or failure).
43 *
44 * @section tutorial_ethumb_client_connect Connecting to Server
45 *
46 * TODO
47 *
48 * @section tutorial_ethumb_client_generate Requesting Thumbnail Generation
49 *
50 * TODO
51 *
52 * @section tutorial_ethumb_client_setup Setup Extra Thumbnail Parameters
53 *
54 * TODO
55 *
56 * @section tutorial_ethumb_client_server_died Handle Server Disconnection
57 *
58 * TODO
59 */
60
61/**
62 * @cond LOCAL
22 */ 63 */
64
23#ifdef HAVE_CONFIG_H 65#ifdef HAVE_CONFIG_H
24#include "config.h" 66#include "config.h"
25#endif 67#endif
@@ -417,6 +459,10 @@ error:
417 _ethumb_client_report_connect(client, 0); 459 _ethumb_client_report_connect(client, 0);
418} 460}
419 461
462/**
463 * @endcond
464 */
465
420EAPI int 466EAPI int
421ethumb_client_init(void) 467ethumb_client_init(void)
422{ 468{
@@ -676,6 +722,10 @@ ethumb_client_on_server_die_callback_set(Ethumb_Client *client, Ethumb_Client_Di
676 client->die.free_data = free_data; 722 client->die.free_data = free_data;
677} 723}
678 724
725/**
726 * @cond LOCAL
727 */
728
679static void 729static void
680_ethumb_client_ethumb_setup_cb(void *data, DBusMessage *msg, DBusError *error) 730_ethumb_client_ethumb_setup_cb(void *data, DBusMessage *msg, DBusError *error)
681{ 731{
@@ -735,6 +785,10 @@ _ethumb_client_dbus_append_bytearray(DBusMessageIter *iter, const char *string)
735} 785}
736 786
737/** 787/**
788 * @endcond
789 */
790
791/**
738 * Send setup to server. 792 * Send setup to server.
739 * 793 *
740 * This method is called automatically by ethumb_client_generate() if 794 * This method is called automatically by ethumb_client_generate() if
@@ -769,6 +823,9 @@ ethumb_client_ethumb_setup(Ethumb_Client *client)
769 dbus_message_iter_init_append(msg, &iter); 823 dbus_message_iter_init_append(msg, &iter);
770 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &aiter); 824 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "{sv}", &aiter);
771 825
826/**
827 * @cond LOCAL
828 */
772#define _open_variant_iter(str_entry, str_type, end_iter) \ 829#define _open_variant_iter(str_entry, str_type, end_iter) \
773 entry = str_entry; \ 830 entry = str_entry; \
774 dbus_message_iter_open_container(&aiter, DBUS_TYPE_DICT_ENTRY, NULL, &diter); \ 831 dbus_message_iter_open_container(&aiter, DBUS_TYPE_DICT_ENTRY, NULL, &diter); \
@@ -779,6 +836,9 @@ ethumb_client_ethumb_setup(Ethumb_Client *client)
779#define _close_variant_iter(end_iter) \ 836#define _close_variant_iter(end_iter) \
780 dbus_message_iter_close_container(&diter, &end_iter); \ 837 dbus_message_iter_close_container(&diter, &end_iter); \
781 dbus_message_iter_close_container(&aiter, &diter); 838 dbus_message_iter_close_container(&aiter, &diter);
839/**
840 * @endcond
841 */
782 842
783 /* starting array elements */ 843 /* starting array elements */
784 844
@@ -880,6 +940,10 @@ ethumb_client_ethumb_setup(Ethumb_Client *client)
880 dbus_message_unref(msg); 940 dbus_message_unref(msg);
881} 941}
882 942
943/**
944 * @cond LOCAL
945 */
946
883static void 947static void
884_ethumb_client_generated_cb(void *data, DBusMessage *msg) 948_ethumb_client_generated_cb(void *data, DBusMessage *msg)
885{ 949{
@@ -1057,6 +1121,9 @@ end:
1057 pending->free_data(pending->data); 1121 pending->free_data(pending->data);
1058 free(pending); 1122 free(pending);
1059} 1123}
1124/**
1125 * @endcond
1126 */
1060 1127
1061/** 1128/**
1062 * Ask server to cancel generation of thumbnail. 1129 * Ask server to cancel generation of thumbnail.
@@ -1154,6 +1221,9 @@ end:
1154 dbus_message_unref(msg); 1221 dbus_message_unref(msg);
1155} 1222}
1156 1223
1224/**
1225 * @cond LOCAL
1226 */
1157static void 1227static void
1158_ethumb_client_queue_clear_cb(void *data, DBusMessage *msg __UNUSED__, DBusError *error __UNUSED__) 1228_ethumb_client_queue_clear_cb(void *data, DBusMessage *msg __UNUSED__, DBusError *error __UNUSED__)
1159{ 1229{
@@ -1161,6 +1231,9 @@ _ethumb_client_queue_clear_cb(void *data, DBusMessage *msg __UNUSED__, DBusError
1161 1231
1162 client->pending_clear = NULL; 1232 client->pending_clear = NULL;
1163} 1233}
1234/**
1235 * @endcond
1236 */
1164 1237
1165/** 1238/**
1166 * Ask server to cancel generation of all thumbnails. 1239 * Ask server to cancel generation of all thumbnails.
diff --git a/legacy/ethumb/src/lib/client/Ethumb_Client.h b/legacy/ethumb/src/lib/client/Ethumb_Client.h
index 2035f6bea6..4b64cb4a37 100644
--- a/legacy/ethumb/src/lib/client/Ethumb_Client.h
+++ b/legacy/ethumb/src/lib/client/Ethumb_Client.h
@@ -37,10 +37,64 @@
37extern "C" { 37extern "C" {
38#endif 38#endif
39 39
40/**
41 * @defgroup Ethumb_Client Client
42 *
43 * @{
44 */
45
46/**
47 * @brief client handle.
48 *
49 * The client handle is created by ethumb_client_connect() and
50 * destroyed by ethumb_client_disconnect(). The connection and
51 * requests are asynchronous and callbacks should be used to report
52 * both success and failure of calls.
53 */
40typedef struct _Ethumb_Client Ethumb_Client; 54typedef struct _Ethumb_Client Ethumb_Client;
55
56/**
57 * @brief reports results of ethumb_client_connect()
58 *
59 * @param data extra context given to ethumb_client_connect().
60 * @param client handle of the current connection to server.
61 * @param success #EINA_TRUE if connected or #EINA_FALSE if it was not possible.
62 */
41typedef void (*Ethumb_Client_Connect_Cb)(void *data, Ethumb_Client *client, Eina_Bool success); 63typedef void (*Ethumb_Client_Connect_Cb)(void *data, Ethumb_Client *client, Eina_Bool success);
64
65/**
66 * @brief reports server connection ended.
67 *
68 * Functions of this type may be called if they are set with
69 * ethumb_client_on_server_die_callback_set().
70 *
71 * @param data extra context given to ethumb_client_on_server_die_callback_set().
72 * @param client handle of the current connection to server.
73 */
42typedef void (*Ethumb_Client_Die_Cb)(void *data, Ethumb_Client *client); 74typedef void (*Ethumb_Client_Die_Cb)(void *data, Ethumb_Client *client);
75
76/**
77 * @brief reports results of ethumb_client_generate().
78 *
79 * @param data extra context given to ethumb_client_generate().
80 * @param client handle of the current connection to server.
81 * @param id identifier returned by ethumb_client_generate().
82 * @param file path set with ethumb_client_file_set().
83 * @param key value set with ethumb_client_file_set() or #NULL.
84 * @param thumb_path where thumbnail was stored, either set with
85 * ethumb_client_thumb_path_set() or automatically calculated
86 * using parameters.
87 * @param thumb_key key inside thumb_path where thumbnail was stored or #NULL.
88 * @param success #EINA_TRUE if generated or #EINA_FALSE on errors.
89 */
43typedef void (*Ethumb_Client_Generate_Cb)(void *data, Ethumb_Client *client, int id, const char *file, const char *key, const char *thumb_path, const char *thumb_key, Eina_Bool success); 90typedef void (*Ethumb_Client_Generate_Cb)(void *data, Ethumb_Client *client, int id, const char *file, const char *key, const char *thumb_path, const char *thumb_key, Eina_Bool success);
91
92/**
93 * @brief reports results of ethumb_client_generate_cancel()
94 *
95 * @param data extra context given to ethumb_client_generate_cancel()
96 * @param client handle of the current connection to server.
97 */
44typedef void (*Ethumb_Client_Generate_Cancel_Cb)(void *data, Eina_Bool success); 98typedef void (*Ethumb_Client_Generate_Cancel_Cb)(void *data, Eina_Bool success);
45 99
46EAPI int ethumb_client_init(void); 100EAPI int ethumb_client_init(void);
@@ -88,6 +142,11 @@ EAPI int ethumb_client_generate(Ethumb_Client *client, Ethumb_Client_Generate_C
88EAPI void ethumb_client_generate_cancel(Ethumb_Client *client, int id, Ethumb_Client_Generate_Cancel_Cb cancel_cb, const void *data, Eina_Free_Cb free_data); 142EAPI void ethumb_client_generate_cancel(Ethumb_Client *client, int id, Ethumb_Client_Generate_Cancel_Cb cancel_cb, const void *data, Eina_Free_Cb free_data);
89EAPI void ethumb_client_generate_cancel_all(Ethumb_Client *client); 143EAPI void ethumb_client_generate_cancel_all(Ethumb_Client *client);
90 144
145/**
146 * @}
147 */
148
149
91#ifdef __cplusplus 150#ifdef __cplusplus
92} 151}
93#endif 152#endif