| 1 |
michael |
3251 |
# Doxyfile 1.3.5 |
| 2 |
|
|
|
| 3 |
|
|
PROJECT_NAME = "PEAK Library" |
| 4 |
|
|
PROJECT_NUMBER = "0.1" |
| 5 |
|
|
OUTPUT_DIRECTORY = doc |
| 6 |
|
|
OUTPUT_LANGUAGE = English |
| 7 |
|
|
USE_WINDOWS_ENCODING = NO |
| 8 |
|
|
BRIEF_MEMBER_DESC = YES |
| 9 |
|
|
REPEAT_BRIEF = YES |
| 10 |
|
|
ABBREVIATE_BRIEF = |
| 11 |
|
|
ALWAYS_DETAILED_SEC = NO |
| 12 |
|
|
INLINE_INHERITED_MEMB = NO |
| 13 |
|
|
FULL_PATH_NAMES = NO |
| 14 |
|
|
STRIP_FROM_PATH = |
| 15 |
|
|
SHORT_NAMES = NO |
| 16 |
|
|
JAVADOC_AUTOBRIEF = NO |
| 17 |
|
|
MULTILINE_CPP_IS_BRIEF = NO |
| 18 |
|
|
DETAILS_AT_TOP = YES |
| 19 |
|
|
INHERIT_DOCS = YES |
| 20 |
|
|
DISTRIBUTE_GROUP_DOC = NO |
| 21 |
|
|
TAB_SIZE = 8 |
| 22 |
|
|
ALIASES = |
| 23 |
|
|
OPTIMIZE_OUTPUT_FOR_C = YES |
| 24 |
|
|
OPTIMIZE_OUTPUT_JAVA = NO |
| 25 |
|
|
SUBGROUPING = YES |
| 26 |
|
|
|
| 27 |
|
|
#--------------------------------------------------------------------------- |
| 28 |
|
|
# Build related configuration options |
| 29 |
|
|
#--------------------------------------------------------------------------- |
| 30 |
|
|
|
| 31 |
|
|
EXTRACT_ALL = NO |
| 32 |
|
|
EXTRACT_PRIVATE = NO |
| 33 |
|
|
EXTRACT_STATIC = NO |
| 34 |
|
|
EXTRACT_LOCAL_CLASSES = YES |
| 35 |
|
|
HIDE_UNDOC_MEMBERS = NO |
| 36 |
|
|
HIDE_UNDOC_CLASSES = NO |
| 37 |
|
|
HIDE_FRIEND_COMPOUNDS = NO |
| 38 |
|
|
HIDE_IN_BODY_DOCS = NO |
| 39 |
|
|
INTERNAL_DOCS = NO |
| 40 |
|
|
CASE_SENSE_NAMES = YES |
| 41 |
|
|
HIDE_SCOPE_NAMES = NO |
| 42 |
|
|
SHOW_INCLUDE_FILES = YES |
| 43 |
|
|
INLINE_INFO = YES |
| 44 |
|
|
SORT_MEMBER_DOCS = YES |
| 45 |
|
|
GENERATE_TODOLIST = YES |
| 46 |
|
|
GENERATE_TESTLIST = YES |
| 47 |
|
|
GENERATE_BUGLIST = YES |
| 48 |
|
|
GENERATE_DEPRECATEDLIST= YES |
| 49 |
|
|
ENABLED_SECTIONS = |
| 50 |
|
|
MAX_INITIALIZER_LINES = 30 |
| 51 |
|
|
SHOW_USED_FILES = YES |
| 52 |
|
|
|
| 53 |
|
|
#--------------------------------------------------------------------------- |
| 54 |
|
|
# configuration options related to warning and progress messages |
| 55 |
|
|
#--------------------------------------------------------------------------- |
| 56 |
|
|
|
| 57 |
|
|
QUIET = NO |
| 58 |
|
|
WARNINGS = YES |
| 59 |
|
|
WARN_IF_UNDOCUMENTED = YES |
| 60 |
|
|
WARN_IF_DOC_ERROR = YES |
| 61 |
|
|
WARN_FORMAT = "$file:$line: $text" |
| 62 |
|
|
WARN_LOGFILE = |
| 63 |
|
|
|
| 64 |
|
|
#--------------------------------------------------------------------------- |
| 65 |
|
|
# configuration options related to the input files |
| 66 |
|
|
#--------------------------------------------------------------------------- |
| 67 |
|
|
|
| 68 |
|
|
INPUT = peak |
| 69 |
|
|
FILE_PATTERNS = *.c *.h |
| 70 |
|
|
RECURSIVE = NO |
| 71 |
|
|
EXCLUDE = |
| 72 |
|
|
EXCLUDE_SYMLINKS = NO |
| 73 |
|
|
EXCLUDE_PATTERNS = |
| 74 |
|
|
EXAMPLE_PATH = peak/examples |
| 75 |
|
|
EXAMPLE_PATTERNS = *.c *.cc *.h |
| 76 |
|
|
EXAMPLE_RECURSIVE = NO |
| 77 |
|
|
IMAGE_PATH = |
| 78 |
|
|
INPUT_FILTER = |
| 79 |
|
|
FILTER_SOURCE_FILES = NO |
| 80 |
|
|
|
| 81 |
|
|
#--------------------------------------------------------------------------- |
| 82 |
|
|
# configuration options related to source browsing |
| 83 |
|
|
#--------------------------------------------------------------------------- |
| 84 |
|
|
|
| 85 |
|
|
SOURCE_BROWSER = NO |
| 86 |
|
|
INLINE_SOURCES = NO |
| 87 |
|
|
STRIP_CODE_COMMENTS = YES |
| 88 |
|
|
REFERENCED_BY_RELATION = YES |
| 89 |
|
|
REFERENCES_RELATION = YES |
| 90 |
|
|
VERBATIM_HEADERS = NO |
| 91 |
|
|
|
| 92 |
|
|
#--------------------------------------------------------------------------- |
| 93 |
|
|
# configuration options related to the alphabetical class index |
| 94 |
|
|
#--------------------------------------------------------------------------- |
| 95 |
|
|
|
| 96 |
|
|
ALPHABETICAL_INDEX = NO |
| 97 |
|
|
COLS_IN_ALPHA_INDEX = 5 |
| 98 |
|
|
IGNORE_PREFIX = |
| 99 |
|
|
|
| 100 |
|
|
#--------------------------------------------------------------------------- |
| 101 |
|
|
# configuration options related to the HTML output |
| 102 |
|
|
#--------------------------------------------------------------------------- |
| 103 |
|
|
|
| 104 |
|
|
GENERATE_HTML = YES |
| 105 |
|
|
HTML_OUTPUT = html |
| 106 |
|
|
HTML_FILE_EXTENSION = .html |
| 107 |
|
|
HTML_HEADER = |
| 108 |
|
|
HTML_FOOTER = doc/Doxyfooter.html |
| 109 |
|
|
HTML_STYLESHEET = |
| 110 |
|
|
HTML_ALIGN_MEMBERS = YES |
| 111 |
|
|
GENERATE_HTMLHELP = NO |
| 112 |
|
|
CHM_FILE = |
| 113 |
|
|
HHC_LOCATION = |
| 114 |
|
|
GENERATE_CHI = NO |
| 115 |
|
|
BINARY_TOC = NO |
| 116 |
|
|
TOC_EXPAND = NO |
| 117 |
|
|
DISABLE_INDEX = NO |
| 118 |
|
|
ENUM_VALUES_PER_LINE = 1 |
| 119 |
|
|
GENERATE_TREEVIEW = NO |
| 120 |
|
|
TREEVIEW_WIDTH = 250 |
| 121 |
|
|
|
| 122 |
|
|
#--------------------------------------------------------------------------- |
| 123 |
|
|
# configuration options related to the LaTeX output |
| 124 |
|
|
#--------------------------------------------------------------------------- |
| 125 |
|
|
|
| 126 |
|
|
GENERATE_LATEX = YES |
| 127 |
|
|
LATEX_OUTPUT = latex |
| 128 |
|
|
LATEX_CMD_NAME = latex |
| 129 |
|
|
MAKEINDEX_CMD_NAME = makeindex |
| 130 |
|
|
COMPACT_LATEX = NO |
| 131 |
|
|
PAPER_TYPE = a4 |
| 132 |
|
|
EXTRA_PACKAGES = |
| 133 |
|
|
LATEX_HEADER = |
| 134 |
|
|
PDF_HYPERLINKS = YES |
| 135 |
|
|
USE_PDFLATEX = YES |
| 136 |
|
|
LATEX_BATCHMODE = NO |
| 137 |
|
|
LATEX_HIDE_INDICES = NO |
| 138 |
|
|
|
| 139 |
|
|
#--------------------------------------------------------------------------- |
| 140 |
|
|
# configuration options related to the RTF output |
| 141 |
|
|
#--------------------------------------------------------------------------- |
| 142 |
|
|
|
| 143 |
|
|
GENERATE_RTF = NO |
| 144 |
|
|
RTF_OUTPUT = rtf |
| 145 |
|
|
COMPACT_RTF = NO |
| 146 |
|
|
RTF_HYPERLINKS = NO |
| 147 |
|
|
RTF_STYLESHEET_FILE = |
| 148 |
|
|
RTF_EXTENSIONS_FILE = |
| 149 |
|
|
|
| 150 |
|
|
#--------------------------------------------------------------------------- |
| 151 |
|
|
# configuration options related to the man page output |
| 152 |
|
|
#--------------------------------------------------------------------------- |
| 153 |
|
|
|
| 154 |
|
|
GENERATE_MAN = NO |
| 155 |
|
|
MAN_OUTPUT = man |
| 156 |
|
|
MAN_EXTENSION = .3 |
| 157 |
|
|
MAN_LINKS = NO |
| 158 |
|
|
|
| 159 |
|
|
#--------------------------------------------------------------------------- |
| 160 |
|
|
# configuration options related to the XML output |
| 161 |
|
|
#--------------------------------------------------------------------------- |
| 162 |
|
|
|
| 163 |
|
|
GENERATE_XML = NO |
| 164 |
|
|
XML_OUTPUT = xml |
| 165 |
|
|
XML_SCHEMA = |
| 166 |
|
|
XML_DTD = |
| 167 |
|
|
XML_PROGRAMLISTING = YES |
| 168 |
|
|
|
| 169 |
|
|
#--------------------------------------------------------------------------- |
| 170 |
|
|
# configuration options for the AutoGen Definitions output |
| 171 |
|
|
#--------------------------------------------------------------------------- |
| 172 |
|
|
|
| 173 |
|
|
GENERATE_AUTOGEN_DEF = NO |
| 174 |
|
|
|
| 175 |
|
|
#--------------------------------------------------------------------------- |
| 176 |
|
|
# configuration options related to the Perl module output |
| 177 |
|
|
#--------------------------------------------------------------------------- |
| 178 |
|
|
|
| 179 |
|
|
GENERATE_PERLMOD = NO |
| 180 |
|
|
PERLMOD_LATEX = NO |
| 181 |
|
|
PERLMOD_PRETTY = YES |
| 182 |
|
|
PERLMOD_MAKEVAR_PREFIX = |
| 183 |
|
|
|
| 184 |
|
|
#--------------------------------------------------------------------------- |
| 185 |
|
|
# Configuration options related to the preprocessor |
| 186 |
|
|
#--------------------------------------------------------------------------- |
| 187 |
|
|
|
| 188 |
|
|
ENABLE_PREPROCESSING = YES |
| 189 |
|
|
MACRO_EXPANSION = NO |
| 190 |
|
|
EXPAND_ONLY_PREDEF = NO |
| 191 |
|
|
SEARCH_INCLUDES = YES |
| 192 |
|
|
INCLUDE_PATH = |
| 193 |
|
|
INCLUDE_FILE_PATTERNS = |
| 194 |
|
|
PREDEFINED = |
| 195 |
|
|
EXPAND_AS_DEFINED = |
| 196 |
|
|
SKIP_FUNCTION_MACROS = YES |
| 197 |
|
|
|
| 198 |
|
|
#--------------------------------------------------------------------------- |
| 199 |
|
|
# Configuration::addtions related to external references |
| 200 |
|
|
#--------------------------------------------------------------------------- |
| 201 |
|
|
|
| 202 |
|
|
TAGFILES = |
| 203 |
|
|
GENERATE_TAGFILE = |
| 204 |
|
|
ALLEXTERNALS = NO |
| 205 |
|
|
EXTERNAL_GROUPS = YES |
| 206 |
|
|
PERL_PATH = /usr/bin/perl |
| 207 |
|
|
|
| 208 |
|
|
#--------------------------------------------------------------------------- |
| 209 |
|
|
# Configuration options related to the dot tool |
| 210 |
|
|
#--------------------------------------------------------------------------- |
| 211 |
|
|
|
| 212 |
|
|
CLASS_DIAGRAMS = NO |
| 213 |
|
|
HIDE_UNDOC_RELATIONS = YES |
| 214 |
|
|
HAVE_DOT = NO |
| 215 |
|
|
CLASS_GRAPH = YES |
| 216 |
|
|
COLLABORATION_GRAPH = YES |
| 217 |
|
|
UML_LOOK = NO |
| 218 |
|
|
TEMPLATE_RELATIONS = NO |
| 219 |
|
|
INCLUDE_GRAPH = YES |
| 220 |
|
|
INCLUDED_BY_GRAPH = YES |
| 221 |
|
|
CALL_GRAPH = NO |
| 222 |
|
|
GRAPHICAL_HIERARCHY = YES |
| 223 |
|
|
DOT_IMAGE_FORMAT = png |
| 224 |
|
|
DOT_PATH = |
| 225 |
|
|
DOTFILE_DIRS = |
| 226 |
|
|
MAX_DOT_GRAPH_WIDTH = 1024 |
| 227 |
|
|
MAX_DOT_GRAPH_HEIGHT = 1024 |
| 228 |
|
|
MAX_DOT_GRAPH_DEPTH = 0 |
| 229 |
|
|
GENERATE_LEGEND = YES |
| 230 |
|
|
DOT_CLEANUP = YES |
| 231 |
|
|
|
| 232 |
|
|
#--------------------------------------------------------------------------- |
| 233 |
|
|
# Configuration::addtions related to the search engine |
| 234 |
|
|
#--------------------------------------------------------------------------- |
| 235 |
|
|
|
| 236 |
|
|
SEARCHENGINE = NO |
