aboutsummaryrefslogtreecommitdiffstats
path: root/doc/sword-api.doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sword-api.doxygen')
-rw-r--r--doc/sword-api.doxygen36
1 files changed, 22 insertions, 14 deletions
diff --git a/doc/sword-api.doxygen b/doc/sword-api.doxygen
index 47e2a5c..a439fc8 100644
--- a/doc/sword-api.doxygen
+++ b/doc/sword-api.doxygen
@@ -4,15 +4,15 @@
# General configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "The Sword Project"
-PROJECT_NUMBER = 1.5.3
+PROJECT_NUMBER = 1.5.5
OUTPUT_DIRECTORY = api-documentation/
OUTPUT_LANGUAGE = English
EXTRACT_ALL = NO
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
-EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_CLASSES = NO
HIDE_UNDOC_MEMBERS = NO
-HIDE_UNDOC_CLASSES = YES
+HIDE_UNDOC_CLASSES = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ALWAYS_DETAILED_SEC = NO
@@ -27,6 +27,8 @@ HIDE_SCOPE_NAMES = NO
VERBATIM_HEADERS = YES
SHOW_INCLUDE_FILES = YES
JAVADOC_AUTOBRIEF = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
@@ -57,7 +59,10 @@ INPUT = ../include/ \
FILE_PATTERNS = *.h \
*.cpp
RECURSIVE = YES
-EXCLUDE = ../include/canon.h
+EXCLUDE = ../include/canon.h \
+ ../include/zlib.h \
+ ../src/utilfuns/zlib/ \
+ ../include/regex.h
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXAMPLE_PATH =
@@ -69,8 +74,8 @@ FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
-SOURCE_BROWSER = YES
-INLINE_SOURCES = YES
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
#---------------------------------------------------------------------------
@@ -90,6 +95,8 @@ HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
@@ -139,14 +146,15 @@ GENERATE_AUTOGEN_DEF = NO
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
-MACRO_EXPANSION = NO
+MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = NO
-SEARCH_INCLUDES = NO
-INCLUDE_PATH =
+SEARCH_INCLUDES = YES
+INCLUDE_PATH = ../include/
INCLUDE_FILE_PATTERNS =
-PREDEFINED =
+PREDEFINED = "SWORD_NAMESPACE_START=namespace sword {" \
+ SWORD_NAMESPACE_END=}
EXPAND_AS_DEFINED =
-SKIP_FUNCTION_MACROS = YES
+SKIP_FUNCTION_MACROS = NO
#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------
@@ -159,16 +167,16 @@ PERL_PATH = /usr/bin/perl
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
+HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
TEMPLATE_RELATIONS = YES
-HIDE_UNDOC_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
-DOT_IMAGE_FORMAT = png
-DOT_PATH =
+DOT_IMAGE_FORMAT = jpg
+DOT_PATH = /usr/bin
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024