1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
|
#
# File docs.conf -- Doxygen configuration for Regina.
#
# General options
PROJECT_NAME = "Regina Calculation Engine"
OUTPUT_DIRECTORY = ../docs/engine
DISABLE_INDEX = NO
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
BRIEF_MEMBER_DESC = YES
JAVADOC_AUTOBRIEF = YES
REPEAT_BRIEF = YES
ALWAYS_DETAILED_SEC = YES
FULL_PATH_NAMES = NO
CLASS_DIAGRAMS = YES
SOURCE_BROWSER = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
CASE_SENSE_NAMES = YES
VERBATIM_HEADERS = NO
# Aliases:
ALIASES = \
"ifaces=\par Interfaces:\n" \
"ifacescpp=\par C++:\n" \
"ifacespython=\par Python:\n" \
"proburgent=<i><b>Bug (urgent):</b></i>" \
"prob=<i>Bug:</i>" \
"problong=<i>Bug (long-term):</i>" \
"featureurgent=<i><b>Feature (urgent):</b></i>" \
"feature=<i>Feature:</i>" \
"featurelong=<i>Feature (long-term):</i>" \
"opturgent=<i><b>Optimise (urgent):</b></i>" \
"opt=<i>Optimise:</i>" \
"optlong=<i>Optimise (long-term):</i>" \
"tidyurgent=<i><b>Tidy (urgent):</b></i>" \
"tidy=<i>Tidy:</i>" \
"tidylong=<i>Tidy (long-term):</i>" \
"testfull=\test Test suite contains thorough tests." \
"testpart=\test Test suite contains partial tests."
# Warning and progress related options:
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
# Input related options:
INPUT = engine \
../python/globalarray.h
FILE_PATTERNS = *.h
RECURSIVE = YES
IMAGE_PATH =
# Alphabetical index options:
ALPHABETICAL_INDEX = YES
IGNORE_PREFIX = N
# HTML related options:
GENERATE_HTML = YES
HTML_OUTPUT = .
HTML_FOOTER = doc-files/doc-footer.html
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
# LaTeX related options:
GENERATE_LATEX = NO
# RTF related options:
GENERATE_RTF = NO
# Man page related options:
GENERATE_MAN = NO
# Preprocessor related options:
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH = .
PREDEFINED = __DOXYGEN
# External reference options:
ALLEXTERNALS = NO
PERL_PATH = /usr/bin/perl
# Dot options:
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
GRAPHICAL_HIERARCHY = NO
# Search engine options:
SEARCHENGINE = NO
|