Doxyfile

Wed, 28 Jul 2010 15:14:54 +0100

author
Philip Pemberton <philpem@philpem.me.uk>
date
Wed, 28 Jul 2010 15:14:54 +0100
changeset 12
f8996e336619
parent 7
3a75ccaaa1ac
permissions
-rw-r--r--

Fixed omission: lpfkbinclock wasn't compiled by default.

philpem@7 1 # Doxyfile 1.5.5
philpem@7 2
philpem@7 3 #---------------------------------------------------------------------------
philpem@7 4 # Project related configuration options
philpem@7 5 #---------------------------------------------------------------------------
philpem@7 6 DOXYFILE_ENCODING = UTF-8
philpem@7 7 PROJECT_NAME = liblpfk
philpem@7 8 PROJECT_NUMBER = "Version 1.0"
philpem@7 9 OUTPUT_DIRECTORY = ./doc
philpem@7 10 CREATE_SUBDIRS = NO
philpem@7 11 OUTPUT_LANGUAGE = English
philpem@7 12 BRIEF_MEMBER_DESC = YES
philpem@7 13 REPEAT_BRIEF = YES
philpem@7 14 ABBREVIATE_BRIEF = "The $name class" \
philpem@7 15 "The $name widget" \
philpem@7 16 "The $name file" \
philpem@7 17 is \
philpem@7 18 provides \
philpem@7 19 specifies \
philpem@7 20 contains \
philpem@7 21 represents \
philpem@7 22 a \
philpem@7 23 an \
philpem@7 24 the
philpem@7 25 ALWAYS_DETAILED_SEC = NO
philpem@7 26 INLINE_INHERITED_MEMB = NO
philpem@7 27 FULL_PATH_NAMES = YES
philpem@7 28 STRIP_FROM_PATH = /home/philpem/Projects/liblpfk/
philpem@7 29 STRIP_FROM_INC_PATH =
philpem@7 30 SHORT_NAMES = NO
philpem@7 31 JAVADOC_AUTOBRIEF = NO
philpem@7 32 QT_AUTOBRIEF = NO
philpem@7 33 MULTILINE_CPP_IS_BRIEF = NO
philpem@7 34 DETAILS_AT_TOP = NO
philpem@7 35 INHERIT_DOCS = YES
philpem@7 36 SEPARATE_MEMBER_PAGES = NO
philpem@7 37 TAB_SIZE = 8
philpem@7 38 ALIASES =
philpem@7 39 OPTIMIZE_OUTPUT_FOR_C = YES
philpem@7 40 OPTIMIZE_OUTPUT_JAVA = NO
philpem@7 41 OPTIMIZE_FOR_FORTRAN = NO
philpem@7 42 OPTIMIZE_OUTPUT_VHDL = NO
philpem@7 43 BUILTIN_STL_SUPPORT = NO
philpem@7 44 CPP_CLI_SUPPORT = NO
philpem@7 45 SIP_SUPPORT = NO
philpem@7 46 DISTRIBUTE_GROUP_DOC = NO
philpem@7 47 SUBGROUPING = YES
philpem@7 48 TYPEDEF_HIDES_STRUCT = NO
philpem@7 49 #---------------------------------------------------------------------------
philpem@7 50 # Build related configuration options
philpem@7 51 #---------------------------------------------------------------------------
philpem@7 52 EXTRACT_ALL = NO
philpem@7 53 EXTRACT_PRIVATE = NO
philpem@7 54 EXTRACT_STATIC = NO
philpem@7 55 EXTRACT_LOCAL_CLASSES = YES
philpem@7 56 EXTRACT_LOCAL_METHODS = NO
philpem@7 57 EXTRACT_ANON_NSPACES = NO
philpem@7 58 HIDE_UNDOC_MEMBERS = YES
philpem@7 59 HIDE_UNDOC_CLASSES = YES
philpem@7 60 HIDE_FRIEND_COMPOUNDS = NO
philpem@7 61 HIDE_IN_BODY_DOCS = NO
philpem@7 62 INTERNAL_DOCS = NO
philpem@7 63 CASE_SENSE_NAMES = YES
philpem@7 64 HIDE_SCOPE_NAMES = NO
philpem@7 65 SHOW_INCLUDE_FILES = YES
philpem@7 66 INLINE_INFO = YES
philpem@7 67 SORT_MEMBER_DOCS = YES
philpem@7 68 SORT_BRIEF_DOCS = NO
philpem@7 69 SORT_GROUP_NAMES = NO
philpem@7 70 SORT_BY_SCOPE_NAME = NO
philpem@7 71 GENERATE_TODOLIST = YES
philpem@7 72 GENERATE_TESTLIST = YES
philpem@7 73 GENERATE_BUGLIST = YES
philpem@7 74 GENERATE_DEPRECATEDLIST= YES
philpem@7 75 ENABLED_SECTIONS =
philpem@7 76 MAX_INITIALIZER_LINES = 30
philpem@7 77 SHOW_USED_FILES = YES
philpem@7 78 SHOW_DIRECTORIES = NO
philpem@7 79 FILE_VERSION_FILTER =
philpem@7 80 #---------------------------------------------------------------------------
philpem@7 81 # configuration options related to warning and progress messages
philpem@7 82 #---------------------------------------------------------------------------
philpem@7 83 QUIET = NO
philpem@7 84 WARNINGS = YES
philpem@7 85 WARN_IF_UNDOCUMENTED = YES
philpem@7 86 WARN_IF_DOC_ERROR = YES
philpem@7 87 WARN_NO_PARAMDOC = NO
philpem@7 88 WARN_FORMAT = "$file:$line: $text"
philpem@7 89 WARN_LOGFILE =
philpem@7 90 #---------------------------------------------------------------------------
philpem@7 91 # configuration options related to the input files
philpem@7 92 #---------------------------------------------------------------------------
philpem@7 93 INPUT = ./src \
philpem@7 94 ./include
philpem@7 95 INPUT_ENCODING = UTF-8
philpem@7 96 FILE_PATTERNS = *.c \
philpem@7 97 *.cc \
philpem@7 98 *.cxx \
philpem@7 99 *.cpp \
philpem@7 100 *.c++ \
philpem@7 101 *.d \
philpem@7 102 *.java \
philpem@7 103 *.ii \
philpem@7 104 *.ixx \
philpem@7 105 *.ipp \
philpem@7 106 *.i++ \
philpem@7 107 *.inl \
philpem@7 108 *.h \
philpem@7 109 *.hh \
philpem@7 110 *.hxx \
philpem@7 111 *.hpp \
philpem@7 112 *.h++ \
philpem@7 113 *.idl \
philpem@7 114 *.odl \
philpem@7 115 *.cs \
philpem@7 116 *.php \
philpem@7 117 *.php3 \
philpem@7 118 *.inc \
philpem@7 119 *.m \
philpem@7 120 *.mm \
philpem@7 121 *.dox \
philpem@7 122 *.py \
philpem@7 123 *.f90 \
philpem@7 124 *.f \
philpem@7 125 *.vhd \
philpem@7 126 *.vhdl \
philpem@7 127 *.C \
philpem@7 128 *.CC \
philpem@7 129 *.C++ \
philpem@7 130 *.II \
philpem@7 131 *.I++ \
philpem@7 132 *.H \
philpem@7 133 *.HH \
philpem@7 134 *.H++ \
philpem@7 135 *.CS \
philpem@7 136 *.PHP \
philpem@7 137 *.PHP3 \
philpem@7 138 *.M \
philpem@7 139 *.MM \
philpem@7 140 *.PY \
philpem@7 141 *.F90 \
philpem@7 142 *.F \
philpem@7 143 *.VHD \
philpem@7 144 *.VHDL
philpem@7 145 RECURSIVE = NO
philpem@7 146 EXCLUDE =
philpem@7 147 EXCLUDE_SYMLINKS = NO
philpem@7 148 EXCLUDE_PATTERNS =
philpem@7 149 EXCLUDE_SYMBOLS =
philpem@7 150 EXAMPLE_PATH =
philpem@7 151 EXAMPLE_PATTERNS = *
philpem@7 152 EXAMPLE_RECURSIVE = NO
philpem@7 153 IMAGE_PATH =
philpem@7 154 INPUT_FILTER =
philpem@7 155 FILTER_PATTERNS =
philpem@7 156 FILTER_SOURCE_FILES = NO
philpem@7 157 #---------------------------------------------------------------------------
philpem@7 158 # configuration options related to source browsing
philpem@7 159 #---------------------------------------------------------------------------
philpem@7 160 SOURCE_BROWSER = YES
philpem@7 161 INLINE_SOURCES = NO
philpem@7 162 STRIP_CODE_COMMENTS = YES
philpem@7 163 REFERENCED_BY_RELATION = YES
philpem@7 164 REFERENCES_RELATION = YES
philpem@7 165 REFERENCES_LINK_SOURCE = YES
philpem@7 166 USE_HTAGS = NO
philpem@7 167 VERBATIM_HEADERS = YES
philpem@7 168 #---------------------------------------------------------------------------
philpem@7 169 # configuration options related to the alphabetical class index
philpem@7 170 #---------------------------------------------------------------------------
philpem@7 171 ALPHABETICAL_INDEX = NO
philpem@7 172 COLS_IN_ALPHA_INDEX = 5
philpem@7 173 IGNORE_PREFIX =
philpem@7 174 #---------------------------------------------------------------------------
philpem@7 175 # configuration options related to the HTML output
philpem@7 176 #---------------------------------------------------------------------------
philpem@7 177 GENERATE_HTML = YES
philpem@7 178 HTML_OUTPUT = html
philpem@7 179 HTML_FILE_EXTENSION = .html
philpem@7 180 HTML_HEADER =
philpem@7 181 HTML_FOOTER =
philpem@7 182 HTML_STYLESHEET =
philpem@7 183 HTML_ALIGN_MEMBERS = YES
philpem@7 184 GENERATE_HTMLHELP = NO
philpem@7 185 GENERATE_DOCSET = NO
philpem@7 186 DOCSET_FEEDNAME = "Doxygen generated docs"
philpem@7 187 DOCSET_BUNDLE_ID = org.doxygen.Project
philpem@7 188 HTML_DYNAMIC_SECTIONS = NO
philpem@7 189 CHM_FILE =
philpem@7 190 HHC_LOCATION =
philpem@7 191 GENERATE_CHI = NO
philpem@7 192 BINARY_TOC = NO
philpem@7 193 TOC_EXPAND = NO
philpem@7 194 DISABLE_INDEX = NO
philpem@7 195 ENUM_VALUES_PER_LINE = 4
philpem@7 196 GENERATE_TREEVIEW = NO
philpem@7 197 TREEVIEW_WIDTH = 250
philpem@7 198 #---------------------------------------------------------------------------
philpem@7 199 # configuration options related to the LaTeX output
philpem@7 200 #---------------------------------------------------------------------------
philpem@7 201 GENERATE_LATEX = NO
philpem@7 202 LATEX_OUTPUT = latex
philpem@7 203 LATEX_CMD_NAME = latex
philpem@7 204 MAKEINDEX_CMD_NAME = makeindex
philpem@7 205 COMPACT_LATEX = NO
philpem@7 206 PAPER_TYPE = a4wide
philpem@7 207 EXTRA_PACKAGES =
philpem@7 208 LATEX_HEADER =
philpem@7 209 PDF_HYPERLINKS = YES
philpem@7 210 USE_PDFLATEX = YES
philpem@7 211 LATEX_BATCHMODE = NO
philpem@7 212 LATEX_HIDE_INDICES = NO
philpem@7 213 #---------------------------------------------------------------------------
philpem@7 214 # configuration options related to the RTF output
philpem@7 215 #---------------------------------------------------------------------------
philpem@7 216 GENERATE_RTF = NO
philpem@7 217 RTF_OUTPUT = rtf
philpem@7 218 COMPACT_RTF = NO
philpem@7 219 RTF_HYPERLINKS = NO
philpem@7 220 RTF_STYLESHEET_FILE =
philpem@7 221 RTF_EXTENSIONS_FILE =
philpem@7 222 #---------------------------------------------------------------------------
philpem@7 223 # configuration options related to the man page output
philpem@7 224 #---------------------------------------------------------------------------
philpem@7 225 GENERATE_MAN = NO
philpem@7 226 MAN_OUTPUT = man
philpem@7 227 MAN_EXTENSION = .3
philpem@7 228 MAN_LINKS = NO
philpem@7 229 #---------------------------------------------------------------------------
philpem@7 230 # configuration options related to the XML output
philpem@7 231 #---------------------------------------------------------------------------
philpem@7 232 GENERATE_XML = NO
philpem@7 233 XML_OUTPUT = xml
philpem@7 234 XML_SCHEMA =
philpem@7 235 XML_DTD =
philpem@7 236 XML_PROGRAMLISTING = YES
philpem@7 237 #---------------------------------------------------------------------------
philpem@7 238 # configuration options for the AutoGen Definitions output
philpem@7 239 #---------------------------------------------------------------------------
philpem@7 240 GENERATE_AUTOGEN_DEF = NO
philpem@7 241 #---------------------------------------------------------------------------
philpem@7 242 # configuration options related to the Perl module output
philpem@7 243 #---------------------------------------------------------------------------
philpem@7 244 GENERATE_PERLMOD = NO
philpem@7 245 PERLMOD_LATEX = NO
philpem@7 246 PERLMOD_PRETTY = YES
philpem@7 247 PERLMOD_MAKEVAR_PREFIX =
philpem@7 248 #---------------------------------------------------------------------------
philpem@7 249 # Configuration options related to the preprocessor
philpem@7 250 #---------------------------------------------------------------------------
philpem@7 251 ENABLE_PREPROCESSING = YES
philpem@7 252 MACRO_EXPANSION = NO
philpem@7 253 EXPAND_ONLY_PREDEF = NO
philpem@7 254 SEARCH_INCLUDES = YES
philpem@7 255 INCLUDE_PATH =
philpem@7 256 INCLUDE_FILE_PATTERNS =
philpem@7 257 PREDEFINED =
philpem@7 258 EXPAND_AS_DEFINED =
philpem@7 259 SKIP_FUNCTION_MACROS = YES
philpem@7 260 #---------------------------------------------------------------------------
philpem@7 261 # Configuration::additions related to external references
philpem@7 262 #---------------------------------------------------------------------------
philpem@7 263 TAGFILES =
philpem@7 264 GENERATE_TAGFILE =
philpem@7 265 ALLEXTERNALS = NO
philpem@7 266 EXTERNAL_GROUPS = YES
philpem@7 267 PERL_PATH = /usr/bin/perl
philpem@7 268 #---------------------------------------------------------------------------
philpem@7 269 # Configuration options related to the dot tool
philpem@7 270 #---------------------------------------------------------------------------
philpem@7 271 CLASS_DIAGRAMS = NO
philpem@7 272 MSCGEN_PATH =
philpem@7 273 HIDE_UNDOC_RELATIONS = YES
philpem@7 274 HAVE_DOT = YES
philpem@7 275 CLASS_GRAPH = YES
philpem@7 276 COLLABORATION_GRAPH = YES
philpem@7 277 GROUP_GRAPHS = YES
philpem@7 278 UML_LOOK = NO
philpem@7 279 TEMPLATE_RELATIONS = NO
philpem@7 280 INCLUDE_GRAPH = YES
philpem@7 281 INCLUDED_BY_GRAPH = YES
philpem@7 282 CALL_GRAPH = YES
philpem@7 283 CALLER_GRAPH = NO
philpem@7 284 GRAPHICAL_HIERARCHY = YES
philpem@7 285 DIRECTORY_GRAPH = YES
philpem@7 286 DOT_IMAGE_FORMAT = png
philpem@7 287 DOT_PATH =
philpem@7 288 DOTFILE_DIRS =
philpem@7 289 DOT_GRAPH_MAX_NODES = 50
philpem@7 290 MAX_DOT_GRAPH_DEPTH = 1000
philpem@7 291 DOT_TRANSPARENT = YES
philpem@7 292 DOT_MULTI_TARGETS = NO
philpem@7 293 GENERATE_LEGEND = YES
philpem@7 294 DOT_CLEANUP = YES
philpem@7 295 #---------------------------------------------------------------------------
philpem@7 296 # Configuration::additions related to the search engine
philpem@7 297 #---------------------------------------------------------------------------
philpem@7 298 SEARCHENGINE = NO