# Doxygen config file for Phonon documentation, adapted from the KDE apidocs

# config file.

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

# Project related configuration options

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

PROJECT_NAME           = Qt

PROJECT_NUMBER         = %VERSION%

OUTPUT_DIRECTORY       = doc

CREATE_SUBDIRS         = NO

OUTPUT_LANGUAGE        = English

USE_WINDOWS_ENCODING   = NO

BRIEF_MEMBER_DESC      = YES

REPEAT_BRIEF           = YES

ABBREVIATE_BRIEF       = "The $name class" \

                         "The $name widget" \

                         "The $name file" \

                         is \

                         provides \

                         specifies \

                         contains \

                         represents \

                         a \

                         an \

                         the

ALWAYS_DETAILED_SEC    = NO

INLINE_INHERITED_MEMB  = NO

FULL_PATH_NAMES        = NO

STRIP_FROM_PATH        =

STRIP_FROM_INC_PATH    =

SHORT_NAMES            = NO

JAVADOC_AUTOBRIEF      = NO

MULTILINE_CPP_IS_BRIEF = NO

DETAILS_AT_TOP         = NO

INHERIT_DOCS           = YES

SEPARATE_MEMBER_PAGES  = NO

TAB_SIZE               = 4

OPTIMIZE_OUTPUT_FOR_C  = NO

OPTIMIZE_OUTPUT_JAVA   = NO

BUILTIN_STL_SUPPORT    = NO

DISTRIBUTE_GROUP_DOC   = NO

SUBGROUPING            = YES

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

# Build related configuration options

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

EXTRACT_ALL            = NO

EXTRACT_PRIVATE        = NO

EXTRACT_STATIC         = YES

EXTRACT_LOCAL_CLASSES  = YES

EXTRACT_LOCAL_METHODS  = NO

HIDE_UNDOC_MEMBERS     = NO

HIDE_UNDOC_CLASSES     = YES

HIDE_FRIEND_COMPOUNDS  = YES

HIDE_IN_BODY_DOCS      = NO

INTERNAL_DOCS          = NO

CASE_SENSE_NAMES       = YES

HIDE_SCOPE_NAMES       = NO

SHOW_INCLUDE_FILES     = YES

INLINE_INFO            = YES

SORT_MEMBER_DOCS       = YES

SORT_BRIEF_DOCS        = NO

SORT_BY_SCOPE_NAME     = NO

GENERATE_TODOLIST      = NO

GENERATE_TESTLIST      = NO

GENERATE_BUGLIST       = NO

GENERATE_DEPRECATEDLIST= NO

ENABLED_SECTIONS       =

MAX_INITIALIZER_LINES  = 30

SHOW_USED_FILES        = YES

SHOW_DIRECTORIES       = NO

FILE_VERSION_FILTER    =

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

# configuration options related to warning and progress messages

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

QUIET                  = NO

WARNINGS               = YES

WARN_IF_UNDOCUMENTED   = YES

WARN_IF_DOC_ERROR      = YES

WARN_NO_PARAMDOC       = YES

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

WARN_LOGFILE           = doxygen.log

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

# configuration options related to the input files

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

INPUT                  = src/3rdparty/kdelibs/phonon

FILE_PATTERNS          = *.cpp \

                         *.h \

                         *.dox

RECURSIVE              = NO

EXCLUDE                =

EXCLUDE_SYMLINKS       = NO

EXCLUDE_PATTERNS       =

EXAMPLE_PATH           =

EXAMPLE_PATTERNS       = *

EXAMPLE_RECURSIVE      = NO

IMAGE_PATH             =

INPUT_FILTER           =

FILTER_PATTERNS        =

FILTER_SOURCE_FILES    = NO

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

# configuration options related to source browsing

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

SOURCE_BROWSER         = NO

INLINE_SOURCES         = NO

STRIP_CODE_COMMENTS    = YES

REFERENCED_BY_RELATION = YES

REFERENCES_RELATION    = YES

REFERENCES_LINK_SOURCE = YES

USE_HTAGS              = NO

VERBATIM_HEADERS       = NO

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

# configuration options related to the alphabetical class index

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

ALPHABETICAL_INDEX     = NO

COLS_IN_ALPHA_INDEX    = 5

IGNORE_PREFIX          =

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

# configuration options related to the HTML output

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

GENERATE_HTML          = YES

HTML_OUTPUT            = html-phonon

HTML_FILE_EXTENSION    = .html

HTML_HEADER            = tools/doxygen/config/header.html

HTML_FOOTER            = tools/doxygen/config/footer.html

HTML_STYLESHEET        = tools/doxygen/config/phonon.css

HTML_ALIGN_MEMBERS     = NO

GENERATE_HTMLHELP      = NO

CHM_FILE               =

HHC_LOCATION           =

GENERATE_CHI           = NO

BINARY_TOC             = NO

TOC_EXPAND             = NO

DISABLE_INDEX          = YES

ENUM_VALUES_PER_LINE   = 4

GENERATE_TREEVIEW      = NO

TREEVIEW_WIDTH         = 250

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

# configuration options related to the LaTeX output

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

GENERATE_LATEX         = NO

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

# configuration options related to the RTF output

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

GENERATE_RTF           = NO

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

# configuration options related to the man page output

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

GENERATE_MAN           = NO

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

# configuration options related to the XML output

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

GENERATE_XML           = NO

XML_OUTPUT             = xml

XML_SCHEMA             =

XML_DTD                =

XML_PROGRAMLISTING     = NO

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

# configuration options for the AutoGen Definitions output

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

GENERATE_AUTOGEN_DEF   = NO

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

# configuration options related to the Perl module output

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

GENERATE_PERLMOD       = NO

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

# Configuration options related to the preprocessor

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

ENABLE_PREPROCESSING   = YES

MACRO_EXPANSION        = NO

EXPAND_ONLY_PREDEF     = NO

SEARCH_INCLUDES        = YES

INCLUDE_PATH           =

INCLUDE_FILE_PATTERNS  =

PREDEFINED             =

EXPAND_AS_DEFINED      =

SKIP_FUNCTION_MACROS   = YES

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

# Configuration::additions related to external references

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

TAGFILES               = doc/indexes/qt.tags

GENERATE_TAGFILE       = doc/indexes/phonon.tags

ALLEXTERNALS           = NO

EXTERNAL_GROUPS        = YES

PERL_PATH              = /usr/bin/perl

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

# Configuration options related to the dot tool

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

CLASS_DIAGRAMS         = NO

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

# Configuration::additions related to the search engine

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

SEARCHENGINE           = NO

### KDE Settings

ALIASES = \

        "intern=\par<b>Internal use only.</b>" \

        "reimp=\par<b>Reimplemented from superclass.</b>" \

        "obsolete=@deprecated" \

        "feature=\xrefitem features \"Feature(s)\" \"Features\"" \

        "maintainer=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \

        "unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \

        "requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \

        "faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \

        "authors=\xrefitem authors \"Author(s)\" \"Authors\"" \

        "maintainers=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \

        "port4=\xrefitem port4 \"KDE 4 Porting Guide\" \"KDE 4 Porting Guide\"" \

        "glossary=\xrefitem glossary \"KDE 4 Glossary\" \"KDE 4 Glossary\"" \

        "acronym=\b "\

        "licenses=\xrefitem licenses \"License(s)\" \"Licenses\"" \

        "short=@brief "\

        "FIXME=\xrefitem fixme \"Fixme\" \"Fixme\"" \

        "bc=\xrefitem bc \"Binary Compatible\" \"Binary Compatible\"" \

        "artistic=<a href=\"http://www.opensource.org/licenses/artistic-license.php\">Artistic</a>" \

        "bsd=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5\">BSD</a>" \

        "x11=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3\">X11</a>" \

        "gpl=<a href=\"http://www.fsf.org/licensing/licenses/gpl.html#SEC1\">GPL</a>" \

        "lgpl=<a href=\"http://www.fsf.org/licensing/licenses/lgpl.html#SEC1\">LGPL</a>" \

        "qpl=<a href=\"http://qt.nokia.com/products/licensing\">QPL</a>"