Doxyfile

# Doxyfile 1.6.3

#
# This is a Doxygen project file (www.doxygen.org) for sView
#
# Copyright © Kirill Gavrilov, 2011
#

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

# Encoding used in this config file
DOXYFILE_ENCODING      = UTF-8

# The PROJECT_NAME tag should identify the project
PROJECT_NAME           = sView

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

# The OUTPUT_DIRECTORY base path where the generated documentation will be put
OUTPUT_DIRECTORY       = Doxygen

# CREATE_SUBDIRS tag
CREATE_SUBDIRS         = NO

# Specify the language in which all documentation generated by doxygen is written
OUTPUT_LANGUAGE        = English

# BRIEF_MEMBER_DESC and REPEAT_BRIEF tags
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES

# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings
ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

# 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

# Show all inherited members of a class in the documentation of that class
# as if those members were ordinary class members
INLINE_INHERITED_MEMB  = NO

# Prepend the full path before files name in the file list and in the header files
FULL_PATH_NAMES        = NO
STRIP_FROM_PATH        =
STRIP_FROM_INC_PATH    =

# Generate shorter file names for compatibility with outdated File Systems
SHORT_NAMES            = NO

# Interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description
JAVADOC_AUTOBRIEF      = NO

# Interpret the first line of a Qt-style comment as the brief description
QT_AUTOBRIEF           = NO

# Treat a multi-line C++ special comment block (a block of //! or /// comments)
# as a brief description
MULTILINE_CPP_IS_BRIEF = NO

# Undocumented member inherits the documentation from any documented member
# that it re-implements
INHERIT_DOCS           = YES

# If set to NO, the documentation of a member will
# be part of the file/class/namespace that contains it
SEPARATE_MEMBER_PAGES  = NO

# Set the number of spaces in a tab
TAB_SIZE               = 4

# A number of aliases that acts as commands in the documentation.
# 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:".
ALIASES                =

# Set to YES if your project consists of C/Java/Fortran/VHDL sources only
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
SIP_SUPPORT            = NO

# With this tag you can assign which parser to use for a given extension.
# The format is ext=language, where language is one of
# the parsers supported by doxygen: C#, C, C++, Objective-C, Java, PHP, Python...
EXTENSION_MAPPING      =

# If you use STL classes but do not want to include the STL sources as input
BUILTIN_STL_SUPPORT    = NO

# Microsoft's features
CPP_CLI_SUPPORT        = 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

# 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)
SUBGROUPING            = YES

# Typedef of a struct, union, or enum with the name of the typedef
TYPEDEF_HIDES_STRUCT   = NO

# The size of the internal cache use to determine which symbols to keep in memory
SYMBOL_CACHE_SIZE      = 0

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

# Assume all entities in documentation are documented, even if no documentation was available.
EXTRACT_ALL            = YES

# Include private members of a class in the documentation
EXTRACT_PRIVATE        = NO

# Include static members of a file in the documentation
EXTRACT_STATIC         = NO

# 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
EXTRACT_LOCAL_METHODS  = NO

# By default anonymous namespace are hidden
EXTRACT_ANON_NSPACES   = NO

# Hide all undocumented members of documented classes, files or namespaces
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS     = NO

# Hide all undocumented classes that are normally visible in the class hierarchy.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES     = NO

# Hide all friend (class|struct|union) declarations
HIDE_FRIEND_COMPOUNDS  = NO

# Hide any documentation blocks found inside the body of a function
HIDE_IN_BODY_DOCS      = NO

# Set it to YES to include the @internal documentation
INTERNAL_DOCS          = NO

# If YES - only generate file names in lower-case letters
CASE_SENSE_NAMES       = NO

# If NO - show members with their full class and namespace scopes in the documentation
HIDE_SCOPE_NAMES       = NO

# Put a list of the files that are included by a file in the documentation of that file
SHOW_INCLUDE_FILES     = YES

# List include files with double quotes in the documentation rather than with sharp brackets
FORCE_LOCAL_INCLUDES   = NO

# Insert [inline] tag in the documentation for inline members
INLINE_INFO            = YES

# Sort the (detailed) documentation of file and class members alphabetically
SORT_MEMBER_DOCS       = YES

# Sort the brief documentation of file, namespace and class members alphabetically
SORT_BRIEF_DOCS        = NO

# Sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first
SORT_MEMBERS_CTORS_1ST = NO

# Sort the hierarchy of group names into alphabetical order
SORT_GROUP_NAMES       = NO

# If YES, the class list will be sorted by fully-qualified names, including namespaces
SORT_BY_SCOPE_NAME     = NO

# Generate @todo/@test/@bug/@deprecated lists
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES

# Enable conditional documentation sections, marked by @if sectionname ... @endif
ENABLED_SECTIONS       =

# Maximum number of lines the initial value of a variable or define consists
# of for it to appear in the documentation
MAX_INITIALIZER_LINES  = 30

# Set NO to disable the list of files generated at the bottom of the documentation
SHOW_USED_FILES        = YES

# Show the directory hierarchy in the documentation
SHOW_DIRECTORIES       = NO

# Set NO to disable the generation of the Files page
SHOW_FILES             = YES

# Set NO to disable the generation of the Namespaces page
SHOW_NAMESPACES        = YES

# Specify a program or script to get the current version for each file
FILE_VERSION_FILTER    =

# Specify a layout file which will be parsed by doxygen.
# If omitted DoxygenLayout.xml will be used as the name of the layout file.
LAYOUT_FILE            =

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

# Turn on/off the messages that are generated by doxygen
QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO

# Determines the format of the warning messages that doxygen can produce
WARN_FORMAT            = "$file:$line: $text"

# Specify a file to which warning and error messages should be written
WARN_LOGFILE           =

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

# Specify the files and/or directories that contain documented source files.
# Separate the files or directories with spaces.
INPUT                  = include \
                         StImageViewer \
                         StMoviePlayer

# Specify the character encoding of the source files
INPUT_ENCODING         = UTF-8

# Specify one or more wildcard pattern to filter out the source-files
FILE_PATTERNS          = *.c \
                         *.cxx \
                         *.cpp \
                         *.ixx \
                         *.h \
                         *.hxx \
                         *.hpp \
                         *.dox

# Specify whether or not subdirectories should be searched for input files as well
RECURSIVE              = YES

# Specify files and/or directories that should excluded from the INPUT source files
EXCLUDE                =

# Select whether or not files or directories that are symbolic links are excluded
EXCLUDE_SYMLINKS       = NO

# Specify patterns to exclude certain files from INCLUDE directories
EXCLUDE_PATTERNS       =

# Specify one or more symbol names (namespaces, classes, functions, etc.)
# that should be excluded from the output
EXCLUDE_SYMBOLS        =

# Specify files or directories that contain example code fragments that are included
EXAMPLE_PATH           =
EXAMPLE_PATTERNS       = *
EXAMPLE_RECURSIVE      = NO

# Specify files or directories that contain @image that are included in the documentation
IMAGE_PATH             =

# Specify a program to filter for each input file
INPUT_FILTER           =

# Specify filters on a per file pattern basis
FILTER_PATTERNS        =

# If YES, the input filter (if set using INPUT_FILTER) will be used to filter
# the input files when producing source files to browse
FILTER_SOURCE_FILES    = NO

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

# Generate list of source files
SOURCE_BROWSER         = NO

# Include the body of functions and classes directly in the documentation
INLINE_SOURCES         = NO

# Hide any special comment blocks from generated source code
# fragments
STRIP_CODE_COMMENTS    = YES

# If YES then for each documented function all documented
# functions referencing it will be listed
REFERENCED_BY_RELATION = NO

# If YES then for each documented function all documented entities
# called/used by that function will be listed
REFERENCES_RELATION    = NO

# If YES, then the hyperlinks from functions lists will link to the source code
REFERENCES_LINK_SOURCE = NO

# Use htags tool instead of doxygen built-in source browser
USE_HTAGS              = NO

# 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
#---------------------------------------------------------------------------

# Enable this if the project contains a lot of classes, structs, unions or interfaces
ALPHABETICAL_INDEX     = NO
COLS_IN_ALPHA_INDEX    = 5
IGNORE_PREFIX          =

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

# Generate HTML output
GENERATE_HTML          = YES

# Specify where the HTML docs will be put
HTML_OUTPUT            = .

# Specify the file extension for each generated HTML page
HTML_FILE_EXTENSION    = .htm

# Specify a personal HTML header and footer for each generated HTML page
HTML_HEADER            =
HTML_FOOTER            =

# Specify a user-defined CSS that is used by each HTML page
HTML_STYLESHEET        =

# If YES then the footer of each generated HTML
# page will contain the date and time when the page was generated
HTML_TIMESTAMP         = YES

# If YES, than members of classes, files or namespaces will be aligned using tables
HTML_ALIGN_MEMBERS     = YES

# Create sections that can be hidden and shown after the page has loaded
HTML_DYNAMIC_SECTIONS  = YES

# Generate an input for Apple's Xcode 3 integrated development environment
GENERATE_DOCSET        = NO

# 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"

# String that should uniquely identify the documentation set bundle
DOCSET_BUNDLE_ID       = org.doxygen.sView

# Generate index files for tools compile HTML help file (.chm)
GENERATE_HTMLHELP      = NO
CHM_FILE               =
HHC_LOCATION           =
GENERATE_CHI           = NO
CHM_INDEX_ENCODING     =
BINARY_TOC             = NO
TOC_EXPAND             = NO

# Generate index file for Qt's qhelpgenerator (.qch)
GENERATE_QHP           = NO
QCH_FILE               =
QHP_NAMESPACE          = org.doxygen.sView
QHP_VIRTUAL_FOLDER     = doc
QHP_CUST_FILTER_NAME   =
QHP_CUST_FILTER_ATTRS  =
QHP_SECT_FILTER_ATTRS  =
QHG_LOCATION           =

# Generate index files for Eclipse help plugin
GENERATE_ECLIPSEHELP   = NO
ECLIPSE_DOC_ID         = org.doxygen.sView

# Turn on/off the condensed index at top of each HTML page.
# The value NO (the default) enables the index and the value YES disables it.
DISABLE_INDEX          = NO

# Set the number of enum values  to group on one line
ENUM_VALUES_PER_LINE   = 1

# Specify whether a tree-like index structure should be generated
# to display hierarchical information (a side panel).
GENERATE_TREEVIEW      = NO

# Generate the Groups, Directories, and Class Hierarchy pages
# using a tree view instead of an ordered list
USE_INLINE_TREES       = NO

# Set the initial width (in pixels) of the frame in which the tree is shown
TREEVIEW_WIDTH         = 250

# Set the font size of Latex formulas included as images in the HTML documentation
FORMULA_FONTSIZE       = 10

# Generate a search box for the HTML output
SEARCHENGINE           = YES

# If enabled the search engine will be implemented using a PHP enabled web server
# instead of at the web client using Javascript
SERVER_BASED_SEARCH    = NO

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

GENERATE_LATEX         = NO
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             = a4wide
EXTRA_PACKAGES         =
LATEX_HEADER           =
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO
LATEX_SOURCE_CODE      = NO

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

GENERATE_RTF           = NO
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =

#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------

GENERATE_MAN           = NO
MAN_OUTPUT             = man
MAN_EXTENSION          = .3
MAN_LINKS              = NO

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

GENERATE_XML           = NO
XML_OUTPUT             = xml
XML_SCHEMA             =
XML_DTD                =
XML_PROGRAMLISTING     = YES

#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

GENERATE_PERLMOD       = NO
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
PERLMOD_MAKEVAR_PREFIX =

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

# Evaluate all C-preprocessor directives found in the sources and include files
ENABLE_PREPROCESSING   = YES

# If Yes, expand all macro names in the source code
MACRO_EXPANSION        = NO
EXPAND_ONLY_PREDEF     = NO

# If YES the includes files in the INCLUDE_PATH will be search if a #include is found
SEARCH_INCLUDES        = YES

# Specify directories that contain include files that are not input files
# but should be processed by the preprocessor
INCLUDE_PATH           =

# Filter out the header-files in the directories
INCLUDE_FILE_PATTERNS  =

# Specify one or more macro names that are defined before the preprocessor is started
# (similar to the -D option of compiler)
PREDEFINED             =

# Specify a list of macro names that should be expanded
EXPAND_AS_DEFINED      =

# Remove all function-like macros that are alone on a line,
# have an all uppercase name, and do not end with a semicolon
SKIP_FUNCTION_MACROS   = YES

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

# Specify one or more tagfiles.
TAGFILES               =
GENERATE_TAGFILE       =

# If YES all external classes will be listed in the class index.
# If set to NO only the inherited external classes will be listed.
ALLEXTERNALS           = NO

# If YES all external groups will be listed in the modules index.
# If set to NO, only the current project's groups will be listed.
EXTERNAL_GROUPS        = YES

# Absolute path and name of the perl script interpreter
PERL_PATH              = /usr/bin/perl

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

# Generate a inheritance diagram for classes with base or super classes
CLASS_DIAGRAMS         = YES

# Path to mscgen tool (to produce the charts)
MSCGEN_PATH            =

# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented or is not a class.
HIDE_UNDOC_RELATIONS   = YES

# Is dot tool (part of Graphviz) available from the path?
HAVE_DOT               = NO

# Font to the output directory and reference it in all dot files
DOT_FONTNAME           = FreeSans

# Set the size of the font of dot graphs
DOT_FONTSIZE           = 10

# Set the path where dot can find font
DOT_FONTPATH           =

# Generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH            = YES

# Generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH    = YES

# Generate a graph for groups, showing the direct groups dependencies
GROUP_GRAPHS           = YES

# Generate inheritance and diagrams in a style similar to the OMG's Unified Modeling Language
UML_LOOK               = NO

# If YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances
TEMPLATE_RELATIONS     = NO

# Generate a graph for each documented file showing the direct and indirect
# include dependencies of the file with other documented files
INCLUDE_GRAPH          = YES

# Generate a graph for each documented header file showing the documented files
# that directly or indirectly include this file
INCLUDED_BY_GRAPH      = YES

# Generate a call dependency graph for every global function or class method
CALL_GRAPH             = NO

# Generate a caller dependency graph for every global function or class method
CALLER_GRAPH           = NO

# Graphical hierarchy of all classes instead of a textual one
GRAPHICAL_HIERARCHY    = YES

# Show the dependencies a directory has on other directories in a graphical way.
# The dependency relations are determined by the #include
# relations between the files in the directories.
DIRECTORY_GRAPH        = YES

# Set the image format of the images generated by dot
DOT_IMAGE_FORMAT       = png

# Specify the path where the dot tool can be found
DOT_PATH               =

# Specify directories that contain dot files that are included in the documentation
DOTFILE_DIRS           =

# Set the maximum number of nodes that will be shown in the graph
DOT_GRAPH_MAX_NODES    = 50

# Set the maximum depth of the graphs generated by dot
MAX_DOT_GRAPH_DEPTH    = 0

# Set YES to generate images with a transparent background
DOT_TRANSPARENT        = NO

# Set YES to allow dot to generate multiple output files in one run
DOT_MULTI_TARGETS      = NO

# Generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs
GENERATE_LEGEND        = YES

# Remove the intermediate dot files that are used to generate the various graphs
DOT_CLEANUP            = YES