RyXéo » ryxeo-WebPhotoAlbum

project (QuaZip)

cmake_minimum_required(VERSION 2.6)

set(qt_min_version "4.5.0")

find_package(Qt4 REQUIRED)

set(QT_USE_QTGUI false)

include(${QT_USE_FILE})

set(LIB_SUFFIX "" CACHE STRING "Define suffix of directory name (32/64)")

set(LIB_DESTINATION "${CMAKE_INSTALL_PREFIX}/lib${LIB_SUFFIX}" CACHE STRING "Library directory name" FORCE)

include_directories(${CMAKE_SOURCE_DIR})

add_subdirectory(quazip)

install(FILES FindQuaZip.cmake DESTINATION ${CMAKE_ROOT}/Modules)

		  GNU LESSER GENERAL PUBLIC LICENSE

		       Version 2.1, February 1999

 Copyright (C) 1991, 1999 Free Software Foundation, Inc.

     51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

 Everyone is permitted to copy and distribute verbatim copies

 of this license document, but changing it is not allowed.

[This is the first released version of the Lesser GPL.  It also counts

 as the successor of the GNU Library Public License, version 2, hence

 the version number 2.1.]

			    Preamble

  The licenses for most software are designed to take away your

freedom to share and change it.  By contrast, the GNU General Public

Licenses are intended to guarantee your freedom to share and change

free software--to make sure the software is free for all its users.

  This license, the Lesser General Public License, applies to some

specially designated software packages--typically libraries--of the

Free Software Foundation and other authors who decide to use it.  You

can use it too, but we suggest you first think carefully about whether

this license or the ordinary General Public License is the better

strategy to use in any particular case, based on the explanations below.

  When we speak of free software, we are referring to freedom of use,

not price.  Our General Public Licenses are designed to make sure that

you have the freedom to distribute copies of free software (and charge

for this service if you wish); that you receive source code or can get

it if you want it; that you can change the software and use pieces of

it in new free programs; and that you are informed that you can do

these things.

  To protect your rights, we need to make restrictions that forbid

distributors to deny you these rights or to ask you to surrender these

rights.  These restrictions translate to certain responsibilities for

you if you distribute copies of the library or if you modify it.

  For example, if you distribute copies of the library, whether gratis

or for a fee, you must give the recipients all the rights that we gave

you.  You must make sure that they, too, receive or can get the source

code.  If you link other code with the library, you must provide

complete object files to the recipients, so that they can relink them

with the library after making changes to the library and recompiling

it.  And you must show them these terms so they know their rights.

  We protect your rights with a two-step method: (1) we copyright the

library, and (2) we offer you this license, which gives you legal

permission to copy, distribute and/or modify the library.

  To protect each distributor, we want to make it very clear that

there is no warranty for the free library.  Also, if the library is

modified by someone else and passed on, the recipients should know

that what they have is not the original version, so that the original

author's reputation will not be affected by problems that might be

introduced by others.

  Finally, software patents pose a constant threat to the existence of

any free program.  We wish to make sure that a company cannot

effectively restrict the users of a free program by obtaining a

restrictive license from a patent holder.  Therefore, we insist that

any patent license obtained for a version of the library must be

consistent with the full freedom of use specified in this license.

  Most GNU software, including some libraries, is covered by the

ordinary GNU General Public License.  This license, the GNU Lesser

General Public License, applies to certain designated libraries, and

is quite different from the ordinary General Public License.  We use

this license for certain libraries in order to permit linking those

libraries into non-free programs.

  When a program is linked with a library, whether statically or using

a shared library, the combination of the two is legally speaking a

combined work, a derivative of the original library.  The ordinary

General Public License therefore permits such linking only if the

entire combination fits its criteria of freedom.  The Lesser General

Public License permits more lax criteria for linking other code with

the library.

  We call this license the "Lesser" General Public License because it

does Less to protect the user's freedom than the ordinary General

Public License.  It also provides other free software developers Less

of an advantage over competing non-free programs.  These disadvantages

are the reason we use the ordinary General Public License for many

libraries.  However, the Lesser license provides advantages in certain

special circumstances.

  For example, on rare occasions, there may be a special need to

encourage the widest possible use of a certain library, so that it becomes

a de-facto standard.  To achieve this, non-free programs must be

allowed to use the library.  A more frequent case is that a free

library does the same job as widely used non-free libraries.  In this

case, there is little to gain by limiting the free library to free

software only, so we use the Lesser General Public License.

  In other cases, permission to use a particular library in non-free

programs enables a greater number of people to use a large body of

free software.  For example, permission to use the GNU C Library in

non-free programs enables many more people to use the whole GNU

operating system, as well as its variant, the GNU/Linux operating

system.

  Although the Lesser General Public License is Less protective of the

users' freedom, it does ensure that the user of a program that is

linked with the Library has the freedom and the wherewithal to run

that program using a modified version of the Library.

  The precise terms and conditions for copying, distribution and

modification follow.  Pay close attention to the difference between a

"work based on the library" and a "work that uses the library".  The

former contains code derived from the library, whereas the latter must

be combined with the library in order to run.

		  GNU LESSER GENERAL PUBLIC LICENSE

   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. This License Agreement applies to any software library or other

program which contains a notice placed by the copyright holder or

other authorized party saying it may be distributed under the terms of

this Lesser General Public License (also called "this License").

Each licensee is addressed as "you".

  A "library" means a collection of software functions and/or data

prepared so as to be conveniently linked with application programs

(which use some of those functions and data) to form executables.

  The "Library", below, refers to any such software library or work

which has been distributed under these terms.  A "work based on the

Library" means either the Library or any derivative work under

copyright law: that is to say, a work containing the Library or a

portion of it, either verbatim or with modifications and/or translated

straightforwardly into another language.  (Hereinafter, translation is

included without limitation in the term "modification".)

  "Source code" for a work means the preferred form of the work for

making modifications to it.  For a library, complete source code means

all the source code for all modules it contains, plus any associated

interface definition files, plus the scripts used to control compilation

and installation of the library.

  Activities other than copying, distribution and modification are not

covered by this License; they are outside its scope.  The act of

running a program using the Library is not restricted, and output from

such a program is covered only if its contents constitute a work based

on the Library (independent of the use of the Library in a tool for

writing it).  Whether that is true depends on what the Library does

and what the program that uses the Library does.

  1. You may copy and distribute verbatim copies of the Library's

complete source code as you receive it, in any medium, provided that

you conspicuously and appropriately publish on each copy an

appropriate copyright notice and disclaimer of warranty; keep intact

all the notices that refer to this License and to the absence of any

warranty; and distribute a copy of this License along with the

Library.

  You may charge a fee for the physical act of transferring a copy,

and you may at your option offer warranty protection in exchange for a

fee.

  2. You may modify your copy or copies of the Library or any portion

of it, thus forming a work based on the Library, and copy and

distribute such modifications or work under the terms of Section 1

above, provided that you also meet all of these conditions:

    a) The modified work must itself be a software library.

    b) You must cause the files modified to carry prominent notices

    stating that you changed the files and the date of any change.

    c) You must cause the whole of the work to be licensed at no

    charge to all third parties under the terms of this License.

    d) If a facility in the modified Library refers to a function or a

    table of data to be supplied by an application program that uses

    the facility, other than as an argument passed when the facility

    is invoked, then you must make a good faith effort to ensure that,

    in the event an application does not supply such function or

    table, the facility still operates, and performs whatever part of

    its purpose remains meaningful.

    (For example, a function in a library to compute square roots has

    a purpose that is entirely well-defined independent of the

    application.  Therefore, Subsection 2d requires that any

    application-supplied function or table used by this function must

    be optional: if the application does not supply it, the square

    root function must still compute square roots.)

These requirements apply to the modified work as a whole.  If

identifiable sections of that work are not derived from the Library,

and can be reasonably considered independent and separate works in

themselves, then this License, and its terms, do not apply to those

sections when you distribute them as separate works.  But when you

distribute the same sections as part of a whole which is a work based

on the Library, the distribution of the whole must be on the terms of

this License, whose permissions for other licensees extend to the

entire whole, and thus to each and every part regardless of who wrote

it.

Thus, it is not the intent of this section to claim rights or contest

your rights to work written entirely by you; rather, the intent is to

exercise the right to control the distribution of derivative or

collective works based on the Library.

In addition, mere aggregation of another work not based on the Library

with the Library (or with a work based on the Library) on a volume of

a storage or distribution medium does not bring the other work under

the scope of this License.

  3. You may opt to apply the terms of the ordinary GNU General Public

License instead of this License to a given copy of the Library.  To do

this, you must alter all the notices that refer to this License, so

that they refer to the ordinary GNU General Public License, version 2,

instead of to this License.  (If a newer version than version 2 of the

ordinary GNU General Public License has appeared, then you can specify

that version instead if you wish.)  Do not make any other change in

these notices.

  Once this change is made in a given copy, it is irreversible for

that copy, so the ordinary GNU General Public License applies to all

subsequent copies and derivative works made from that copy.

  This option is useful when you wish to copy part of the code of

the Library into a program that is not a library.

  4. You may copy and distribute the Library (or a portion or

derivative of it, under Section 2) in object code or executable form

under the terms of Sections 1 and 2 above provided that you accompany

it with the complete corresponding machine-readable source code, which

must be distributed under the terms of Sections 1 and 2 above on a

medium customarily used for software interchange.

  If distribution of object code is made by offering access to copy

from a designated place, then offering equivalent access to copy the

source code from the same place satisfies the requirement to

distribute the source code, even though third parties are not

compelled to copy the source along with the object code.

  5. A program that contains no derivative of any portion of the

Library, but is designed to work with the Library by being compiled or

linked with it, is called a "work that uses the Library".  Such a

work, in isolation, is not a derivative work of the Library, and

therefore falls outside the scope of this License.

  However, linking a "work that uses the Library" with the Library

creates an executable that is a derivative of the Library (because it

contains portions of the Library), rather than a "work that uses the

library".  The executable is therefore covered by this License.

Section 6 states terms for distribution of such executables.

  When a "work that uses the Library" uses material from a header file

that is part of the Library, the object code for the work may be a

derivative work of the Library even though the source code is not.

Whether this is true is especially significant if the work can be

linked without the Library, or if the work is itself a library.  The

threshold for this to be true is not precisely defined by law.

  If such an object file uses only numerical parameters, data

structure layouts and accessors, and small macros and small inline

functions (ten lines or less in length), then the use of the object

file is unrestricted, regardless of whether it is legally a derivative

work.  (Executables containing this object code plus portions of the

Library will still fall under Section 6.)

  Otherwise, if the work is a derivative of the Library, you may

distribute the object code for the work under the terms of Section 6.

Any executables containing that work also fall under Section 6,

whether or not they are linked directly with the Library itself.

  6. As an exception to the Sections above, you may also combine or

link a "work that uses the Library" with the Library to produce a

work containing portions of the Library, and distribute that work

under terms of your choice, provided that the terms permit

modification of the work for the customer's own use and reverse

engineering for debugging such modifications.

  You must give prominent notice with each copy of the work that the

Library is used in it and that the Library and its use are covered by

this License.  You must supply a copy of this License.  If the work

during execution displays copyright notices, you must include the

copyright notice for the Library among them, as well as a reference

directing the user to the copy of this License.  Also, you must do one

of these things:

    a) Accompany the work with the complete corresponding

    machine-readable source code for the Library including whatever

    changes were used in the work (which must be distributed under

    Sections 1 and 2 above); and, if the work is an executable linked

    with the Library, with the complete machine-readable "work that

    uses the Library", as object code and/or source code, so that the

    user can modify the Library and then relink to produce a modified

    executable containing the modified Library.  (It is understood

    that the user who changes the contents of definitions files in the

    Library will not necessarily be able to recompile the application

    to use the modified definitions.)

    b) Use a suitable shared library mechanism for linking with the

    Library.  A suitable mechanism is one that (1) uses at run time a

    copy of the library already present on the user's computer system,

    rather than copying library functions into the executable, and (2)

    will operate properly with a modified version of the library, if

    the user installs one, as long as the modified version is

    interface-compatible with the version that the work was made with.

    c) Accompany the work with a written offer, valid for at

    least three years, to give the same user the materials

    specified in Subsection 6a, above, for a charge no more

    than the cost of performing this distribution.

    d) If distribution of the work is made by offering access to copy

    from a designated place, offer equivalent access to copy the above

    specified materials from the same place.

    e) Verify that the user has already received a copy of these

    materials or that you have already sent this user a copy.

  For an executable, the required form of the "work that uses the

Library" must include any data and utility programs needed for

reproducing the executable from it.  However, as a special exception,

the materials to be distributed need not include anything that is

normally distributed (in either source or binary form) with the major

components (compiler, kernel, and so on) of the operating system on

which the executable runs, unless that component itself accompanies

the executable.

  It may happen that this requirement contradicts the license

restrictions of other proprietary libraries that do not normally

accompany the operating system.  Such a contradiction means you cannot

use both them and the Library together in an executable that you

distribute.

  7. You may place library facilities that are a work based on the

Library side-by-side in a single library together with other library

facilities not covered by this License, and distribute such a combined

library, provided that the separate distribution of the work based on

the Library and of the other library facilities is otherwise

permitted, and provided that you do these two things:

    a) Accompany the combined library with a copy of the same work

    based on the Library, uncombined with any other library

    facilities.  This must be distributed under the terms of the

    Sections above.

    b) Give prominent notice with the combined library of the fact

    that part of it is a work based on the Library, and explaining

    where to find the accompanying uncombined form of the same work.

  8. You may not copy, modify, sublicense, link with, or distribute

the Library except as expressly provided under this License.  Any

attempt otherwise to copy, modify, sublicense, link with, or

distribute the Library is void, and will automatically terminate your

rights under this License.  However, parties who have received copies,

or rights, from you under this License will not have their licenses

terminated so long as such parties remain in full compliance.

  9. You are not required to accept this License, since you have not

signed it.  However, nothing else grants you permission to modify or

distribute the Library or its derivative works.  These actions are

prohibited by law if you do not accept this License.  Therefore, by

modifying or distributing the Library (or any work based on the

Library), you indicate your acceptance of this License to do so, and

all its terms and conditions for copying, distributing or modifying

the Library or works based on it.

  10. Each time you redistribute the Library (or any work based on the

Library), the recipient automatically receives a license from the

original licensor to copy, distribute, link with or modify the Library

subject to these terms and conditions.  You may not impose any further

restrictions on the recipients' exercise of the rights granted herein.

You are not responsible for enforcing compliance by third parties with

this License.

  11. If, as a consequence of a court judgment or allegation of patent

infringement or for any other reason (not limited to patent issues),

conditions are imposed on you (whether by court order, agreement or

otherwise) that contradict the conditions of this License, they do not

excuse you from the conditions of this License.  If you cannot

distribute so as to satisfy simultaneously your obligations under this

License and any other pertinent obligations, then as a consequence you

may not distribute the Library at all.  For example, if a patent

license would not permit royalty-free redistribution of the Library by

all those who receive copies directly or indirectly through you, then

the only way you could satisfy both it and this License would be to

refrain entirely from distribution of the Library.

If any portion of this section is held invalid or unenforceable under any

particular circumstance, the balance of the section is intended to apply,

and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any

patents or other property right claims or to contest validity of any

such claims; this section has the sole purpose of protecting the

integrity of the free software distribution system which is

implemented by public license practices.  Many people have made

generous contributions to the wide range of software distributed

through that system in reliance on consistent application of that

system; it is up to the author/donor to decide if he or she is willing

to distribute software through any other system and a licensee cannot

impose that choice.

This section is intended to make thoroughly clear what is believed to

be a consequence of the rest of this License.

  12. If the distribution and/or use of the Library is restricted in

certain countries either by patents or by copyrighted interfaces, the

original copyright holder who places the Library under this License may add

an explicit geographical distribution limitation excluding those countries,

so that distribution is permitted only in or among countries not thus

excluded.  In such case, this License incorporates the limitation as if

written in the body of this License.

  13. The Free Software Foundation may publish revised and/or new

versions of the Lesser General Public License from time to time.

Such new versions will be similar in spirit to the present version,

but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number.  If the Library

specifies a version number of this License which applies to it and

"any later version", you have the option of following the terms and

conditions either of that version or of any later version published by

the Free Software Foundation.  If the Library does not specify a

license version number, you may choose any version ever published by

the Free Software Foundation.

  14. If you wish to incorporate parts of the Library into other free

programs whose distribution conditions are incompatible with these,

write to the author to ask for permission.  For software which is

copyrighted by the Free Software Foundation, write to the Free

Software Foundation; we sometimes make exceptions for this.  Our

decision will be guided by the two goals of preserving the free status

of all derivatives of our free software and of promoting the sharing

and reuse of software generally.

			    NO WARRANTY

  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO

WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.

EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR

OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY

KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE

IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE

LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME

THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN

WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY

AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU

FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR

CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE

LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING

RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A

FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF

SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH

DAMAGES.

		     END OF TERMS AND CONDITIONS

# Doxyfile 1.7.4

# This file describes the settings to be used by the documentation system

# doxygen (www.doxygen.org) for a project.

#

# All text after a hash (#) is considered a comment and will be ignored.

# The format is:

#       TAG = value [value, ...]

# For lists items can also be appended using:

#       TAG += value [value, ...]

# Values that contain spaces should be placed between quotes (" ").

#---------------------------------------------------------------------------

# Project related configuration options

#---------------------------------------------------------------------------

# This tag specifies the encoding used for all characters in the config file

# that follow. The default is UTF-8 which is also the encoding used for all

# text before the first occurrence of this tag. Doxygen uses libiconv (or the

# iconv built into libc) for the transcoding. See

# http://www.gnu.org/software/libiconv for the list of possible encodings.

DOXYFILE_ENCODING      = UTF-8

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded

# by quotes) that should identify the project.

PROJECT_NAME           = QuaZIP

# The PROJECT_NUMBER tag can be used to enter a project or revision number.

# This could be handy for archiving the generated documentation or

# if some version control system is used.

PROJECT_NUMBER         = quazip-0-4-3

# Using the PROJECT_BRIEF tag one can provide an optional one line description

# for a project that appears at the top of each page and should give viewer

# a quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF          =

# With the PROJECT_LOGO tag one can specify an logo or icon that is

# included in the documentation. The maximum height of the logo should not

# exceed 55 pixels and the maximum width should not exceed 200 pixels.

# Doxygen will copy the logo to the output directory.

PROJECT_LOGO           =

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)

# base path where the generated documentation will be put.

# If a relative path is entered, it will be relative to the location

# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = doc

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create

# 4096 sub-directories (in 2 levels) under the output directory of each output

# format and will distribute the generated files over these directories.

# Enabling this option can be useful when feeding doxygen a huge amount of

# source files, where putting all generated files in the same directory would

# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

# The OUTPUT_LANGUAGE tag is used to specify the language in which all

# documentation generated by doxygen is written. Doxygen will use this

# information to generate all constant output in the proper language.

# The default language is English, other supported languages are:

# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,

# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,

# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English

# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,

# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,

# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.

OUTPUT_LANGUAGE        = English

# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will

# include brief member descriptions after the members that are listed in

# the file and class documentation (similar to JavaDoc).

# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend

# the brief description of a member or function before the detailed description.

# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the

# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

# This tag implements a quasi-intelligent brief description abbreviator

# that is used to form the text in various listings. Each string

# in this list, if found as the leading text of the brief description, will be

# stripped from the text and the result after processing the whole list, is

# used as the annotated text. Otherwise, the brief description is used as-is.

# If left blank, the following values are used ("$name" is automatically

# replaced with the name of the entity): "The $name class" "The $name widget"

# "The $name file" "is" "provides" "specifies" "contains"

# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       =

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then

# Doxygen will generate a detailed section even if there is only a brief

# description.

ALWAYS_DETAILED_SEC    = NO

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all

# inherited members of a class in the documentation of that class as if those

# members were ordinary class members. Constructors, destructors and assignment

# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full

# path before files name in the file list and in the header files. If set

# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag

# can be used to strip a user-defined part of the path. Stripping is

# only done if one of the specified strings matches the left-hand part of

# the path. The tag can be used to show relative paths in the file list.

# If left blank the directory from which doxygen is run is used as the

# path to strip.

STRIP_FROM_PATH        =

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of

# the path mentioned in the documentation of a class, which tells

# the reader which header file to include in order to use a class.

# If left blank only the name of the header file containing the class

# definition is used. Otherwise one should specify the include paths that

# are normally passed to the compiler using the -I flag.

STRIP_FROM_INC_PATH    =

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter

# (but less readable) file names. This can be useful if your file system

# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen

# will interpret the first line (until the first dot) of a JavaDoc-style

# comment as the brief description. If set to NO, the JavaDoc

# comments will behave just like regular Qt-style comments

# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

# If the QT_AUTOBRIEF tag is set to YES then Doxygen will

# interpret the first line (until the first dot) of a Qt-style

# comment as the brief description. If set to NO, the comments

# will behave just like regular Qt-style comments (thus requiring

# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen

# treat a multi-line C++ special comment block (i.e. a block of //! or ///

# comments) as a brief description. This used to be the default behaviour.

# The new default is to treat a multi-line C++ comment block as a detailed

# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented

# member inherits the documentation from any documented member that it

# re-implements.

INHERIT_DOCS           = YES

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce

# a new page for each member. If set to NO, the documentation of a member will

# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

# The TAB_SIZE tag can be used to set the number of spaces in a tab.

# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

# This tag can be used to specify a number of aliases that acts

# as commands in the documentation. An alias has the form "name=value".

# For example adding "sideeffect=\par Side Effects:\n" will allow you to

# put the command \sideeffect (or @sideeffect) in the documentation, which

# will result in a user-defined paragraph with heading "Side Effects:".

# You can put \n's in the value part of an alias to insert newlines.

ALIASES                =

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C

# sources only. Doxygen will then generate output that is more tailored for C.

# For instance, some of the names that are used will be different. The list

# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java

# sources only. Doxygen will then generate output that is more tailored for

# Java. For instance, namespaces will be presented as packages, qualified

# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran

# sources only. Doxygen will then generate output that is more tailored for

# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL

# sources. Doxygen will then generate output that is tailored for

# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

# Doxygen selects the parser to use depending on the extension of the files it

# parses. With this tag you can assign which parser to use for a given extension.

# Doxygen has a built-in mapping, but you can override or extend it using this

# tag. The format is ext=language, where ext is a file extension, and language

# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,

# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make

# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C

# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions

# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

EXTENSION_MAPPING      =

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want

# to include (a tag file for) the STL sources as input, then you should

# set this tag to YES in order to let doxygen match functions declarations and

# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.

# func(std::string) {}). This also makes the inheritance and collaboration

# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to

# enable parsing support.

CPP_CLI_SUPPORT        = NO

# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.

# Doxygen will parse them like normal C++ but will assume all classes use public

# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

# For Microsoft's IDL there are propget and propput attributes to indicate getter

# and setter methods for a property. Setting this option to YES (the default)

# will make doxygen replace the get and set methods by a property in the

# documentation. This will only work if the methods are indeed getting or

# setting a simple type. If this is not the case, or you want to show the

# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC

# tag is set to YES, then doxygen will reuse the documentation of the first

# member in the group (if any) for the other members of the group. By default

# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

# Set the SUBGROUPING tag to YES (the default) to allow class member groups of

# the same type (for instance a group of public functions) to be put as a

# subgroup of that type (e.g. under the Public Functions section). Set it to

# NO to prevent subgrouping. Alternatively, this can be done per class using

# the \nosubgrouping command.

SUBGROUPING            = YES

# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and

# unions are shown inside the group in which they are included (e.g. using

# @ingroup) instead of on a separate page (for HTML and Man pages) or

# section (for LaTeX and RTF).

INLINE_GROUPED_CLASSES = NO

# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum

# is documented as struct, union, or enum with the name of the typedef. So

# typedef struct TypeS {} TypeT, will appear in the documentation as a struct

# with name TypeT. When disabled the typedef will appear as a member of a file,

# namespace, or class. And the struct will be named TypeS. This can typically

# be useful for C code in case the coding convention dictates that all compound

# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to

# determine which symbols to keep in memory and which to flush to disk.

# When the cache is full, less often used symbols will be written to disk.

# For small to medium size projects (<1000 input files) the default value is

# probably good enough. For larger projects a too small cache size can cause

# doxygen to be busy swapping symbols to and from disk most of the time

# causing a significant performance penalty.

# If the system has enough physical memory increasing the cache will improve the

# performance by keeping more symbols in memory. Note that the value works on

# a logarithmic scale so increasing the size by one will roughly double the

# memory usage. The cache size is given by this formula:

# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,

# corresponding to a cache size of 2^16 = 65536 symbols

SYMBOL_CACHE_SIZE      = 0

#---------------------------------------------------------------------------

# Build related configuration options

#---------------------------------------------------------------------------

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in

# documentation are documented, even if no documentation was available.

# Private class members and static file members will be hidden unless

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = NO

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class

# will be included in the documentation.

EXTRACT_PRIVATE        = NO

# If the EXTRACT_STATIC tag is set to YES all static members of a file

# will be included in the documentation.

EXTRACT_STATIC         = NO

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)

# defined locally in source files will be included in the documentation.

# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

# This flag is only useful for Objective-C code. When set to YES local

# methods, which are defined in the implementation section but not in

# the interface are included in the documentation.

# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

# If this flag is set to YES, the members of anonymous namespaces will be

# extracted and appear in the documentation as a namespace called

# 'anonymous_namespace{file}', where file will be replaced with the base

# name of the file that contains the anonymous namespace. By default

# anonymous namespaces are hidden.

EXTRACT_ANON_NSPACES   = NO

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all

# undocumented members of documented classes, files or namespaces.

# If set to NO (the default) these members will be included in the

# various overviews, but no documentation section is generated.

# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all

# undocumented classes that are normally visible in the class hierarchy.

# If set to NO (the default) these classes will be included in the various

# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all

# friend (class|struct|union) declarations.

# If set to NO (the default) these declarations will be included in the

# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any

# documentation blocks found inside the body of a function.

# If set to NO (the default) these blocks will be appended to the

# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

# The INTERNAL_DOCS tag determines if documentation

# that is typed after a \internal command is included. If the tag is set

# to NO (the default) then the documentation will be excluded.

# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate

# file names in lower-case letters. If set to YES upper-case letters are also

# allowed. This is useful if you have classes or files whose names only differ

# in case and if your file system supports case sensitive file names. Windows

# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = YES

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen

# will show members with their full class and namespace scopes in the

# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen

# will put a list of the files that are included by a file in the documentation

# of that file.

SHOW_INCLUDE_FILES     = YES

# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen

# will list include files with double quotes in the documentation

# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]

# is inserted in the documentation for inline members.

INLINE_INFO            = YES

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen

# will sort the (detailed) documentation of file and class members

# alphabetically by member name. If set to NO the members will appear in

# declaration order.

SORT_MEMBER_DOCS       = NO

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the

# brief documentation of file, namespace and class members alphabetically

# by member name. If set to NO (the default) the members will appear in

# declaration order.

SORT_BRIEF_DOCS        = NO

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen

# will sort the (brief and detailed) documentation of class members so that

# constructors and destructors are listed first. If set to NO (the default)

# the constructors will appear in the respective orders defined by

# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.

# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO

# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the

# hierarchy of group names into alphabetical order. If set to NO (the default)

# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be

# sorted by fully-qualified names, including namespaces. If set to

# NO (the default), the class list will be sorted only by class name,

# not including the namespace part.

# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.

# Note: This option applies only to the class list, not to the

# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to

# do proper type resolution of all parameters of a function it will reject a

# match between the prototype and the implementation of a member function even

# if there is only one candidate or it is obvious which candidate to choose

# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen

# will still accept a match between prototype and implementation in such cases.

STRICT_PROTO_MATCHING  = NO

# The GENERATE_TODOLIST tag can be used to enable (YES) or

# disable (NO) the todo list. This list is created by putting \todo

# commands in the documentation.

GENERATE_TODOLIST      = YES

# The GENERATE_TESTLIST tag can be used to enable (YES) or

# disable (NO) the test list. This list is created by putting \test

# commands in the documentation.

GENERATE_TESTLIST      = YES

# The GENERATE_BUGLIST tag can be used to enable (YES) or

# disable (NO) the bug list. This list is created by putting \bug

# commands in the documentation.

GENERATE_BUGLIST       = YES

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or

# disable (NO) the deprecated list. This list is created by putting

# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

# The ENABLED_SECTIONS tag can be used to enable conditional

# documentation sections, marked by \if sectionname ... \endif.

ENABLED_SECTIONS       =

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines

# the initial value of a variable or macro consists of for it to appear in

# the documentation. If the initializer consists of more lines than specified

# here it will be hidden. Use a value of 0 to hide initializers completely.

# The appearance of the initializer of individual variables and macros in the

# documentation can be controlled using \showinitializer or \hideinitializer

# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

# Set the SHOW_USED_FILES tag to NO to disable the list of files generated

# at the bottom of the documentation of classes and structs. If set to YES the

# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

# If the sources in your project are distributed over multiple directories

# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy

# in the documentation. The default is NO.

SHOW_DIRECTORIES       = YES

# Set the SHOW_FILES tag to NO to disable the generation of the Files page.

# This will remove the Files entry from the Quick Index and from the

# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the

# Namespaces page.

# This will remove the Namespaces entry from the Quick Index

# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that

# doxygen should invoke to get the current version for each file (typically from

# the version control system). Doxygen will invoke the program by executing (via

# popen()) the command <command> <input-file>, where <command> is the value of

# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file

# provided by doxygen. Whatever the program writes to standard output

# is used as the file version. See the manual for examples.

FILE_VERSION_FILTER    =

# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed

# by doxygen. The layout file controls the global structure of the generated

# output files in an output format independent way. The create the layout file

# that represents doxygen's defaults, run doxygen with the -l option.

# You can optionally specify a file name after the option, if omitted

# DoxygenLayout.xml will be used as the name of the layout file.

LAYOUT_FILE            =

#---------------------------------------------------------------------------

# configuration options related to warning and progress messages

#---------------------------------------------------------------------------

# The QUIET tag can be used to turn on/off the messages that are generated

# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = NO

# The WARNINGS tag can be used to turn on/off the warning messages that are

# generated by doxygen. Possible values are YES and NO. If left blank

# NO is used.

WARNINGS               = YES

# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings

# for undocumented members. If EXTRACT_ALL is set to YES then this flag will

# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for

# potential errors in the documentation, such as not documenting some

# parameters in a documented function, or documenting parameters that

# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

# The WARN_NO_PARAMDOC option can be enabled to get warnings for

# functions that are documented, but have no documentation for their parameters

# or return value. If set to NO (the default) doxygen will only warn about

# wrong or incomplete parameter documentation, but not about the absence of

# documentation.

WARN_NO_PARAMDOC       = NO

# The WARN_FORMAT tag determines the format of the warning messages that

# doxygen can produce. The string should contain the $file, $line, and $text

# tags, which will be replaced by the file and line number from which the

# warning originated and the warning text. Optionally the format may contain

# $version, which will be replaced by the version of the file (if it could

# be obtained via FILE_VERSION_FILTER)

WARN_FORMAT            = "$file:$line: $text"

# The WARN_LOGFILE tag can be used to specify a file to which warning

# and error messages should be written. If left blank the output is written

# to stderr.

WARN_LOGFILE           =

#---------------------------------------------------------------------------

# configuration options related to the input files

#---------------------------------------------------------------------------

# The INPUT tag can be used to specify the files and/or directories that contain

# documented source files. You may enter file names like "myfile.cpp" or

# directories like "/usr/src/myproject". Separate the files or directories

# with spaces.

INPUT                  =

# This tag can be used to specify the character encoding of the source files

# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

# also the default input encoding. Doxygen uses libiconv (or the iconv built

# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for

# the list of possible encodings.

INPUT_ENCODING         = UTF-8

# If the value of the INPUT tag contains directories, you can use the

# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

# and *.h) to filter out the source-files in the directories. If left

# blank the following patterns are tested:

# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh

# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py

# *.f90 *.f *.for *.vhd *.vhdl

FILE_PATTERNS          = *.cpp \

                         *.h \

                         *.dox

# The RECURSIVE tag can be used to turn specify whether or not subdirectories

# should be searched for input files as well. Possible values are YES and NO.

# If left blank NO is used.

RECURSIVE              = YES

# The EXCLUDE tag can be used to specify files and/or directories that should

# excluded from the INPUT source files. This way you can easily exclude a

# subdirectory from a directory tree whose root is specified with the INPUT tag.

EXCLUDE                = quazip/unzip.h \

                         quazip/zip.h \

                         quazip/ioapi.h \

                         quazip/crypt.h

# The EXCLUDE_SYMLINKS tag can be used select whether or not files or

# directories that are symbolic links (a Unix file system feature) are excluded

# from the input.

EXCLUDE_SYMLINKS       = NO

# If the value of the INPUT tag contains directories, you can use the

# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude

# certain files from those directories. Note that the wildcards are matched

# against the file with absolute path, so to exclude all test directories

# for example use the pattern */test/*

EXCLUDE_PATTERNS       = */.moc/* */release/* */debug/*

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

# (namespaces, classes, functions, etc.) that should be excluded from the

# output. The symbol name can be a fully qualified name, a word, or if the

# wildcard * is used, a substring. Examples: ANamespace, AClass,

# AClass::ANamespace, ANamespace::*Test

EXCLUDE_SYMBOLS        =

# The EXAMPLE_PATH tag can be used to specify one or more files or

# directories that contain example code fragments that are included (see

# the \include command).

EXAMPLE_PATH           =

# If the value of the EXAMPLE_PATH tag contains directories, you can use the

# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

# and *.h) to filter out the source-files in the directories. If left

# blank all files are included.

EXAMPLE_PATTERNS       =

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be

# searched for input files to be used with the \include or \dontinclude

# commands irrespective of the value of the RECURSIVE tag.

# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

# The IMAGE_PATH tag can be used to specify one or more files or

# directories that contain image that are included in the documentation (see

# the \image command).

IMAGE_PATH             =

# The INPUT_FILTER tag can be used to specify a program that doxygen should

# invoke to filter for each input file. Doxygen will invoke the filter program

# by executing (via popen()) the command <filter> <input-file>, where <filter>

# is the value of the INPUT_FILTER tag, and <input-file> is the name of an

# input file. Doxygen will then use the output that the filter program writes

# to standard output.

# If FILTER_PATTERNS is specified, this tag will be

# ignored.

INPUT_FILTER           =

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern

# basis.

# Doxygen will compare the file name with each pattern and apply the

# filter if there is a match.

# The filters are a list of the form:

# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further

# info on how filters are used. If FILTER_PATTERNS is empty or if

# non of the patterns match the file name, INPUT_FILTER is applied.

FILTER_PATTERNS        =

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using

# INPUT_FILTER) will be used to filter the input files when producing source

# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file

# pattern. A pattern will override the setting for FILTER_PATTERN (if any)

# and it is also possible to disable source filtering for a specific pattern

# using *.ext= (so without naming a filter). This option only has effect when

# FILTER_SOURCE_FILES is enabled.

FILTER_SOURCE_PATTERNS =

#---------------------------------------------------------------------------

# configuration options related to source browsing

#---------------------------------------------------------------------------

# If the SOURCE_BROWSER tag is set to YES then a list of source files will

# be generated. Documented entities will be cross-referenced with these sources.

# Note: To get rid of all source code in the generated output, make sure also

# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = NO

# Setting the INLINE_SOURCES tag to YES will include the body

# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct

# doxygen to hide any special comment blocks from generated source code

# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

# If the REFERENCED_BY_RELATION tag is set to YES

# then for each documented function all documented

# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

# If the REFERENCES_RELATION tag is set to YES

# then for each documented function all documented entities

# called/used by that function will be listed.

REFERENCES_RELATION    = YES

# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)

# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from

# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will

# link to the source code.

# Otherwise they will link to the documentation.

REFERENCES_LINK_SOURCE = YES

# If the USE_HTAGS tag is set to YES then the references to source code

# will point to the HTML generated by the htags(1) tool instead of doxygen

# built-in source browser. The htags tool is part of GNU's global source

# tagging system (see http://www.gnu.org/software/global/global.html). You

# will need version 4.8.6 or higher.

USE_HTAGS              = NO

# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen

# will generate a verbatim copy of the header file for each class for

# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------

# configuration options related to the alphabetical class index

#---------------------------------------------------------------------------

# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index

# of all compounds will be generated. Enable this if the project

# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = NO

# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then

# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns

# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

# In case all classes in a project start with a common prefix, all

# classes will be put under the same header in the alphabetical index.

# The IGNORE_PREFIX tag can be used to specify one or more prefixes that

# should be ignored while generating the index headers.

IGNORE_PREFIX          =

#---------------------------------------------------------------------------

# configuration options related to the HTML output

#---------------------------------------------------------------------------

# If the GENERATE_HTML tag is set to YES (the default) Doxygen will

# generate HTML output.

GENERATE_HTML          = YES

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.

# If a relative path is entered the value of OUTPUT_DIRECTORY will be

# put in front of it. If left blank `html' will be used as the default path.

HTML_OUTPUT            = html

# The HTML_FILE_EXTENSION tag can be used to specify the file extension for

# each generated HTML page (for example: .htm,.php,.asp). If it is left blank

# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

# The HTML_HEADER tag can be used to specify a personal HTML header for

# each generated HTML page. If it is left blank doxygen will generate a

# standard header. Note that when using a custom header you are responsible

# for the proper inclusion of any scripts and style sheets that doxygen

# needs, which is dependent on the configuration options used.

# It is adviced to generate a default header using "doxygen -w html

# header.html footer.html stylesheet.css YourConfigFile" and then modify

# that header. Note that the header is subject to change so you typically

# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!

HTML_HEADER            =

# The HTML_FOOTER tag can be used to specify a personal HTML footer for

# each generated HTML page. If it is left blank doxygen will generate a

# standard footer.

HTML_FOOTER            =

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading

# style sheet that is used by each HTML page. It can be used to

# fine-tune the look of the HTML output. If the tag is left blank doxygen

# will generate a default style sheet. Note that doxygen will try to copy

# the style sheet file to the HTML output directory, so don't put your own

# stylesheet in the HTML output directory as well, or it will be erased!

HTML_STYLESHEET        =

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or

# other source files which should be copied to the HTML output directory. Note

# that these files will be copied to the base HTML output directory. Use the

# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these

# files. In the HTML_STYLESHEET file, use the file name only. Also note that

# the files will be copied as-is; there are no commands or markers available.

HTML_EXTRA_FILES       =

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.

# Doxygen will adjust the colors in the stylesheet and background images

# according to this color. Hue is specified as an angle on a colorwheel,

# see http://en.wikipedia.org/wiki/Hue for more information.

# For instance the value 0 represents red, 60 is yellow, 120 is green,

# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.

# The allowed range is 0 to 359.

HTML_COLORSTYLE_HUE    = 220

# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of

# the colors in the HTML output. For a value of 0 the output will use

# grayscales only. A value of 255 will produce the most vivid colors.

HTML_COLORSTYLE_SAT    = 100

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to

# the luminance component of the colors in the HTML output. Values below

# 100 gradually make the output lighter, whereas values above 100 make

# the output darker. The value divided by 100 is the actual gamma applied,

# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,

# and 100 does not change the gamma.

HTML_COLORSTYLE_GAMMA  = 80

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML

# page will contain the date and time when the page was generated. Setting

# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = YES

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,

# files or namespaces will be aligned in HTML using tables. If set to

# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML

# documentation will contain sections that can be hidden and shown after the

# page has loaded. For this to work a browser that supports

# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox

# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

HTML_DYNAMIC_SECTIONS  = NO

# If the GENERATE_DOCSET tag is set to YES, additional index files

# will be generated that can be used as input for Apple's Xcode 3

# integrated development environment, introduced with OSX 10.5 (Leopard).

# To create a documentation set, doxygen will generate a Makefile in the

# HTML output directory. Running make will produce the docset in that

# directory and running "make install" will install the docset in

# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find

# it at startup.

# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html

# for more information.

GENERATE_DOCSET        = NO

# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the

# feed. A documentation feed provides an umbrella under which multiple

# documentation sets from a single provider (such as a company or product suite)

# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that

# should uniquely identify the documentation set bundle. This should be a

# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen

# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify

# the documentation publisher. This should be a reverse domain-name style

# string, e.g. com.mycompany.MyDocSet.documentation.

DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

DOCSET_PUBLISHER_NAME  = Publisher

# If the GENERATE_HTMLHELP tag is set to YES, additional index files

# will be generated that can be used as input for tools like the

# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)

# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can

# be used to specify the file name of the resulting .chm file. You

# can add a path in front of the file if the result should not be

# written to the html output directory.

CHM_FILE               =

# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can

# be used to specify the location (absolute path including file name) of

# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run

# the HTML help compiler on the generated index.hhp.

HHC_LOCATION           =

# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag

# controls if a separate .chi index file is generated (YES) or that

# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING

# is used to encode HtmlHelp index (hhk), content (hhc) and project file

# content.

CHM_INDEX_ENCODING     =

# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag

# controls whether a binary table of contents is generated (YES) or a

# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

# The TOC_EXPAND flag can be set to YES to add extra items for group members

# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and

# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated

# that can be used as input for Qt's qhelpgenerator to generate a

# Qt Compressed Help (.qch) of the generated HTML documentation.

GENERATE_QHP           = NO

# If the QHG_LOCATION tag is specified, the QCH_FILE tag can

# be used to specify the file name of the resulting .qch file.