Files
OpenSpace/Doxyfile
Alexander Bock e3d5a9ca38 Cleaned up Doxygen
Removed Doxygen warnings
Documented Property specializations (closing #10)
2016-09-05 17:01:32 +02:00

105 lines
3.5 KiB
Plaintext

# Doxyfile 1.8.8
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = OpenSpace
PROJECT_NUMBER =
PROJECT_LOGO =
OUTPUT_DIRECTORY = doc/
ALWAYS_DETAILED_SEC = YES
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = YES
INLINE_SIMPLE_STRUCTS = YES
LOOKUP_CACHE_SIZE = 9
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = YES
SHOW_INCLUDE_FILES = YES
INLINE_INFO = NO
SORT_BRIEF_DOCS = YES
SORT_MEMBERS_CTORS_1ST = YES
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST= YES
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = NO
SHOW_FILES = YES
LAYOUT_FILE =
EXTENSION_MAPPING = inl=C++
BUILTIN_STL_SUPPORT = YES
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = src \
include
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.cpp \
*.h \
*.inl
RECURSIVE = YES
EXCLUDE_PATTERNS = ext/* bin/* build/* config/* gui/* kernels/* data/* scripts/* shaders/*
USE_MDFILE_AS_MAINPAGE = README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
HTML_HEADER = support/doxygen/header.html
HTML_FOOTER = support/doxygen/footer.html
HTML_STYLESHEET = support/doxygen/stylesheet.css
HTML_COLORSTYLE_HUE = 225
HTML_COLORSTYLE_SAT = 18
HTML_COLORSTYLE_GAMMA = 100
GENERATE_TREEVIEW = YES
ENUM_VALUES_PER_LINE = 6
TREEVIEW_WIDTH = 300
#---------------------------------------------------------------------------
# Other output configuration options
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_XML = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = NO
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
EXPAND_AS_DEFINED = YES
SKIP_FUNCTION_MACROS = NO