# This file contains project-specific configurations for the 
# deal.II documentation.

PROJECT_NAME           = "The deal.II Library"
PROJECT_NUMBER         = "Reference documentation for deal.II version @DEAL_II_PACKAGE_VERSION@"
PROJECT_LOGO           = @CMAKE_CURRENT_SOURCE_DIR@/images/logo200.png
OUTPUT_DIRECTORY       = .

# The doxygen documentation says this about the following flag:
#   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.
# We set the flag to NO since we occasionally need to reference individual
# doxygen-generated files from other parts of the documentation and need
# to have predictable file paths.
#
# The same is true for SHORT_NAMES, which compresses file names, and
# CASE_SENSE_NAMES which allows file names to contain upper case letters.
CREATE_SUBDIRS         = NO
SHORT_NAMES            = NO
CASE_SENSE_NAMES       = YES


INLINE_INHERITED_MEMB  = NO
STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ @CMAKE_BINARY_DIR@
JAVADOC_AUTOBRIEF      = NO
INHERIT_DOCS           = YES
TAB_SIZE               = 8

BUILTIN_STL_SUPPORT    = YES


#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
SORT_MEMBER_DOCS       = NO
SORT_BRIEF_DOCS        = NO
SORT_BY_SCOPE_NAME     = NO
GENERATE_TODOLIST      = YES
GENERATE_DEPRECATEDLIST= YES
SHOW_USED_FILES        = YES

#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

QUIET                  = YES
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

INPUT                  =
EXCLUDE_PATTERNS       = *.templates.h
EXAMPLE_PATH           = @CMAKE_BINARY_DIR@/doc/doxygen/tutorial \
                         @CMAKE_SOURCE_DIR@/examples/doxygen
EXAMPLE_RECURSIVE      = NO
IMAGE_PATH             =
INPUT_FILTER           = ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/filter
FILTER_SOURCE_FILES    = YES

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

SOURCE_BROWSER         = YES
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = YES
USE_HTAGS              = NO
VERBATIM_HEADERS       = NO

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

ALPHABETICAL_INDEX     = YES
COLS_IN_ALPHA_INDEX    = 3

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

GENERATE_HTML          = YES
HTML_OUTPUT            = deal.II
HTML_FILE_EXTENSION    = .html
HTML_HEADER            = header.html
HTML_FOOTER            = footer.html
USE_MATHJAX            = NO
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols
HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 200
HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

# don't generate latex output -- it's simply too big!
GENERATE_LATEX         = NO

# but set a few flags for when processing formulas embedded
# in the documentation.
PAPER_TYPE             = a4wide
EXTRA_PACKAGES         = amsmath amsfonts
LATEX_BATCHMODE        = YES

#---------------------------------------------------------------------------
# Other output formats
#---------------------------------------------------------------------------

GENERATE_RTF           = NO
GENERATE_MAN           = NO
GENERATE_XML           = YES
GENERATE_AUTOGEN_DEF   = NO
GENERATE_PERLMOD       = NO

#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SEARCH_INCLUDES        = YES
INCLUDE_PATH           = @CMAKE_SOURCE_DIR@/include/deal.II
INCLUDE_FILE_PATTERNS  =

# set a few variables that help us generate documentation for
# things like the PETSc and Trilinos wrappers, even if they were
# not configured
PREDEFINED             = DOXYGEN=1 \
                         DEBUG=1 \
                         DEAL_II_WITH_PETSC=1 \
                         DEAL_II_WITH_SLEPC=1 \
                         DEAL_II_WITH_TRILINOS=1 \
                         DEAL_II_WITH_THREADS=1 \
                         DEAL_II_USE_MT_POSIX=1 \
			 DEAL_II_WITH_ARPACK=1 \
			 DEAL_II_WITH_METIS=1 \
			 DEAL_II_WITH_MUMPS=1 \
			 DEAL_II_WITH_P4EST=1 \
			 DEAL_II_WITH_MPI=1

# do not expand exception declarations
EXPAND_AS_DEFINED      = DeclException0 \
                         DeclException1 \
                         DeclException2 \
                         DeclException3 \
                         DeclException4 \
                         DeclException5
SKIP_FUNCTION_MACROS   = YES

#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------

GENERATE_TAGFILE       = deal.tag
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------

CLASS_DIAGRAMS         = YES
HIDE_UNDOC_RELATIONS   = NO
HAVE_DOT               = YES
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = NO
GROUP_GRAPHS           = YES
UML_LOOK               = NO
TEMPLATE_RELATIONS     = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
GRAPHICAL_HIERARCHY    = NO
DIRECTORY_GRAPH        = YES
DOT_IMAGE_FORMAT       = svg
MAX_DOT_GRAPH_DEPTH    = 5
DOT_TRANSPARENT        = NO
GENERATE_LEGEND        = YES

DOT_CLEANUP            = YES

#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------

SEARCHENGINE           = YES
SERVER_BASED_SEARCH    = NO
