add Doxygen control file

Tue, 26 Aug 2008 22:01:01 +0100

author
Philip Pemberton <philpem@philpem.me.uk>
date
Tue, 26 Aug 2008 22:01:01 +0100
changeset 7
3a75ccaaa1ac
parent 6
aed399ff850b
child 8
fd84ec9e11df

add Doxygen control file

Doxyfile file | annotate | diff | revisions
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/Doxyfile	Tue Aug 26 22:01:01 2008 +0100
     1.3 @@ -0,0 +1,298 @@
     1.4 +# Doxyfile 1.5.5
     1.5 +
     1.6 +#---------------------------------------------------------------------------
     1.7 +# Project related configuration options
     1.8 +#---------------------------------------------------------------------------
     1.9 +DOXYFILE_ENCODING      = UTF-8
    1.10 +PROJECT_NAME           = liblpfk
    1.11 +PROJECT_NUMBER         = "Version 1.0"
    1.12 +OUTPUT_DIRECTORY       = ./doc
    1.13 +CREATE_SUBDIRS         = NO
    1.14 +OUTPUT_LANGUAGE        = English
    1.15 +BRIEF_MEMBER_DESC      = YES
    1.16 +REPEAT_BRIEF           = YES
    1.17 +ABBREVIATE_BRIEF       = "The $name class" \
    1.18 +                         "The $name widget" \
    1.19 +                         "The $name file" \
    1.20 +                         is \
    1.21 +                         provides \
    1.22 +                         specifies \
    1.23 +                         contains \
    1.24 +                         represents \
    1.25 +                         a \
    1.26 +                         an \
    1.27 +                         the
    1.28 +ALWAYS_DETAILED_SEC    = NO
    1.29 +INLINE_INHERITED_MEMB  = NO
    1.30 +FULL_PATH_NAMES        = YES
    1.31 +STRIP_FROM_PATH        = /home/philpem/Projects/liblpfk/
    1.32 +STRIP_FROM_INC_PATH    = 
    1.33 +SHORT_NAMES            = NO
    1.34 +JAVADOC_AUTOBRIEF      = NO
    1.35 +QT_AUTOBRIEF           = NO
    1.36 +MULTILINE_CPP_IS_BRIEF = NO
    1.37 +DETAILS_AT_TOP         = NO
    1.38 +INHERIT_DOCS           = YES
    1.39 +SEPARATE_MEMBER_PAGES  = NO
    1.40 +TAB_SIZE               = 8
    1.41 +ALIASES                = 
    1.42 +OPTIMIZE_OUTPUT_FOR_C  = YES
    1.43 +OPTIMIZE_OUTPUT_JAVA   = NO
    1.44 +OPTIMIZE_FOR_FORTRAN   = NO
    1.45 +OPTIMIZE_OUTPUT_VHDL   = NO
    1.46 +BUILTIN_STL_SUPPORT    = NO
    1.47 +CPP_CLI_SUPPORT        = NO
    1.48 +SIP_SUPPORT            = NO
    1.49 +DISTRIBUTE_GROUP_DOC   = NO
    1.50 +SUBGROUPING            = YES
    1.51 +TYPEDEF_HIDES_STRUCT   = NO
    1.52 +#---------------------------------------------------------------------------
    1.53 +# Build related configuration options
    1.54 +#---------------------------------------------------------------------------
    1.55 +EXTRACT_ALL            = NO
    1.56 +EXTRACT_PRIVATE        = NO
    1.57 +EXTRACT_STATIC         = NO
    1.58 +EXTRACT_LOCAL_CLASSES  = YES
    1.59 +EXTRACT_LOCAL_METHODS  = NO
    1.60 +EXTRACT_ANON_NSPACES   = NO
    1.61 +HIDE_UNDOC_MEMBERS     = YES
    1.62 +HIDE_UNDOC_CLASSES     = YES
    1.63 +HIDE_FRIEND_COMPOUNDS  = NO
    1.64 +HIDE_IN_BODY_DOCS      = NO
    1.65 +INTERNAL_DOCS          = NO
    1.66 +CASE_SENSE_NAMES       = YES
    1.67 +HIDE_SCOPE_NAMES       = NO
    1.68 +SHOW_INCLUDE_FILES     = YES
    1.69 +INLINE_INFO            = YES
    1.70 +SORT_MEMBER_DOCS       = YES
    1.71 +SORT_BRIEF_DOCS        = NO
    1.72 +SORT_GROUP_NAMES       = NO
    1.73 +SORT_BY_SCOPE_NAME     = NO
    1.74 +GENERATE_TODOLIST      = YES
    1.75 +GENERATE_TESTLIST      = YES
    1.76 +GENERATE_BUGLIST       = YES
    1.77 +GENERATE_DEPRECATEDLIST= YES
    1.78 +ENABLED_SECTIONS       = 
    1.79 +MAX_INITIALIZER_LINES  = 30
    1.80 +SHOW_USED_FILES        = YES
    1.81 +SHOW_DIRECTORIES       = NO
    1.82 +FILE_VERSION_FILTER    = 
    1.83 +#---------------------------------------------------------------------------
    1.84 +# configuration options related to warning and progress messages
    1.85 +#---------------------------------------------------------------------------
    1.86 +QUIET                  = NO
    1.87 +WARNINGS               = YES
    1.88 +WARN_IF_UNDOCUMENTED   = YES
    1.89 +WARN_IF_DOC_ERROR      = YES
    1.90 +WARN_NO_PARAMDOC       = NO
    1.91 +WARN_FORMAT            = "$file:$line: $text"
    1.92 +WARN_LOGFILE           = 
    1.93 +#---------------------------------------------------------------------------
    1.94 +# configuration options related to the input files
    1.95 +#---------------------------------------------------------------------------
    1.96 +INPUT                  = ./src \
    1.97 +                         ./include
    1.98 +INPUT_ENCODING         = UTF-8
    1.99 +FILE_PATTERNS          = *.c \
   1.100 +                         *.cc \
   1.101 +                         *.cxx \
   1.102 +                         *.cpp \
   1.103 +                         *.c++ \
   1.104 +                         *.d \
   1.105 +                         *.java \
   1.106 +                         *.ii \
   1.107 +                         *.ixx \
   1.108 +                         *.ipp \
   1.109 +                         *.i++ \
   1.110 +                         *.inl \
   1.111 +                         *.h \
   1.112 +                         *.hh \
   1.113 +                         *.hxx \
   1.114 +                         *.hpp \
   1.115 +                         *.h++ \
   1.116 +                         *.idl \
   1.117 +                         *.odl \
   1.118 +                         *.cs \
   1.119 +                         *.php \
   1.120 +                         *.php3 \
   1.121 +                         *.inc \
   1.122 +                         *.m \
   1.123 +                         *.mm \
   1.124 +                         *.dox \
   1.125 +                         *.py \
   1.126 +                         *.f90 \
   1.127 +                         *.f \
   1.128 +                         *.vhd \
   1.129 +                         *.vhdl \
   1.130 +                         *.C \
   1.131 +                         *.CC \
   1.132 +                         *.C++ \
   1.133 +                         *.II \
   1.134 +                         *.I++ \
   1.135 +                         *.H \
   1.136 +                         *.HH \
   1.137 +                         *.H++ \
   1.138 +                         *.CS \
   1.139 +                         *.PHP \
   1.140 +                         *.PHP3 \
   1.141 +                         *.M \
   1.142 +                         *.MM \
   1.143 +                         *.PY \
   1.144 +                         *.F90 \
   1.145 +                         *.F \
   1.146 +                         *.VHD \
   1.147 +                         *.VHDL
   1.148 +RECURSIVE              = NO
   1.149 +EXCLUDE                = 
   1.150 +EXCLUDE_SYMLINKS       = NO
   1.151 +EXCLUDE_PATTERNS       = 
   1.152 +EXCLUDE_SYMBOLS        = 
   1.153 +EXAMPLE_PATH           = 
   1.154 +EXAMPLE_PATTERNS       = *
   1.155 +EXAMPLE_RECURSIVE      = NO
   1.156 +IMAGE_PATH             = 
   1.157 +INPUT_FILTER           = 
   1.158 +FILTER_PATTERNS        = 
   1.159 +FILTER_SOURCE_FILES    = NO
   1.160 +#---------------------------------------------------------------------------
   1.161 +# configuration options related to source browsing
   1.162 +#---------------------------------------------------------------------------
   1.163 +SOURCE_BROWSER         = YES
   1.164 +INLINE_SOURCES         = NO
   1.165 +STRIP_CODE_COMMENTS    = YES
   1.166 +REFERENCED_BY_RELATION = YES
   1.167 +REFERENCES_RELATION    = YES
   1.168 +REFERENCES_LINK_SOURCE = YES
   1.169 +USE_HTAGS              = NO
   1.170 +VERBATIM_HEADERS       = YES
   1.171 +#---------------------------------------------------------------------------
   1.172 +# configuration options related to the alphabetical class index
   1.173 +#---------------------------------------------------------------------------
   1.174 +ALPHABETICAL_INDEX     = NO
   1.175 +COLS_IN_ALPHA_INDEX    = 5
   1.176 +IGNORE_PREFIX          = 
   1.177 +#---------------------------------------------------------------------------
   1.178 +# configuration options related to the HTML output
   1.179 +#---------------------------------------------------------------------------
   1.180 +GENERATE_HTML          = YES
   1.181 +HTML_OUTPUT            = html
   1.182 +HTML_FILE_EXTENSION    = .html
   1.183 +HTML_HEADER            = 
   1.184 +HTML_FOOTER            = 
   1.185 +HTML_STYLESHEET        = 
   1.186 +HTML_ALIGN_MEMBERS     = YES
   1.187 +GENERATE_HTMLHELP      = NO
   1.188 +GENERATE_DOCSET        = NO
   1.189 +DOCSET_FEEDNAME        = "Doxygen generated docs"
   1.190 +DOCSET_BUNDLE_ID       = org.doxygen.Project
   1.191 +HTML_DYNAMIC_SECTIONS  = NO
   1.192 +CHM_FILE               = 
   1.193 +HHC_LOCATION           = 
   1.194 +GENERATE_CHI           = NO
   1.195 +BINARY_TOC             = NO
   1.196 +TOC_EXPAND             = NO
   1.197 +DISABLE_INDEX          = NO
   1.198 +ENUM_VALUES_PER_LINE   = 4
   1.199 +GENERATE_TREEVIEW      = NO
   1.200 +TREEVIEW_WIDTH         = 250
   1.201 +#---------------------------------------------------------------------------
   1.202 +# configuration options related to the LaTeX output
   1.203 +#---------------------------------------------------------------------------
   1.204 +GENERATE_LATEX         = NO
   1.205 +LATEX_OUTPUT           = latex
   1.206 +LATEX_CMD_NAME         = latex
   1.207 +MAKEINDEX_CMD_NAME     = makeindex
   1.208 +COMPACT_LATEX          = NO
   1.209 +PAPER_TYPE             = a4wide
   1.210 +EXTRA_PACKAGES         = 
   1.211 +LATEX_HEADER           = 
   1.212 +PDF_HYPERLINKS         = YES
   1.213 +USE_PDFLATEX           = YES
   1.214 +LATEX_BATCHMODE        = NO
   1.215 +LATEX_HIDE_INDICES     = NO
   1.216 +#---------------------------------------------------------------------------
   1.217 +# configuration options related to the RTF output
   1.218 +#---------------------------------------------------------------------------
   1.219 +GENERATE_RTF           = NO
   1.220 +RTF_OUTPUT             = rtf
   1.221 +COMPACT_RTF            = NO
   1.222 +RTF_HYPERLINKS         = NO
   1.223 +RTF_STYLESHEET_FILE    = 
   1.224 +RTF_EXTENSIONS_FILE    = 
   1.225 +#---------------------------------------------------------------------------
   1.226 +# configuration options related to the man page output
   1.227 +#---------------------------------------------------------------------------
   1.228 +GENERATE_MAN           = NO
   1.229 +MAN_OUTPUT             = man
   1.230 +MAN_EXTENSION          = .3
   1.231 +MAN_LINKS              = NO
   1.232 +#---------------------------------------------------------------------------
   1.233 +# configuration options related to the XML output
   1.234 +#---------------------------------------------------------------------------
   1.235 +GENERATE_XML           = NO
   1.236 +XML_OUTPUT             = xml
   1.237 +XML_SCHEMA             = 
   1.238 +XML_DTD                = 
   1.239 +XML_PROGRAMLISTING     = YES
   1.240 +#---------------------------------------------------------------------------
   1.241 +# configuration options for the AutoGen Definitions output
   1.242 +#---------------------------------------------------------------------------
   1.243 +GENERATE_AUTOGEN_DEF   = NO
   1.244 +#---------------------------------------------------------------------------
   1.245 +# configuration options related to the Perl module output
   1.246 +#---------------------------------------------------------------------------
   1.247 +GENERATE_PERLMOD       = NO
   1.248 +PERLMOD_LATEX          = NO
   1.249 +PERLMOD_PRETTY         = YES
   1.250 +PERLMOD_MAKEVAR_PREFIX = 
   1.251 +#---------------------------------------------------------------------------
   1.252 +# Configuration options related to the preprocessor   
   1.253 +#---------------------------------------------------------------------------
   1.254 +ENABLE_PREPROCESSING   = YES
   1.255 +MACRO_EXPANSION        = NO
   1.256 +EXPAND_ONLY_PREDEF     = NO
   1.257 +SEARCH_INCLUDES        = YES
   1.258 +INCLUDE_PATH           = 
   1.259 +INCLUDE_FILE_PATTERNS  = 
   1.260 +PREDEFINED             = 
   1.261 +EXPAND_AS_DEFINED      = 
   1.262 +SKIP_FUNCTION_MACROS   = YES
   1.263 +#---------------------------------------------------------------------------
   1.264 +# Configuration::additions related to external references   
   1.265 +#---------------------------------------------------------------------------
   1.266 +TAGFILES               = 
   1.267 +GENERATE_TAGFILE       = 
   1.268 +ALLEXTERNALS           = NO
   1.269 +EXTERNAL_GROUPS        = YES
   1.270 +PERL_PATH              = /usr/bin/perl
   1.271 +#---------------------------------------------------------------------------
   1.272 +# Configuration options related to the dot tool   
   1.273 +#---------------------------------------------------------------------------
   1.274 +CLASS_DIAGRAMS         = NO
   1.275 +MSCGEN_PATH            = 
   1.276 +HIDE_UNDOC_RELATIONS   = YES
   1.277 +HAVE_DOT               = YES
   1.278 +CLASS_GRAPH            = YES
   1.279 +COLLABORATION_GRAPH    = YES
   1.280 +GROUP_GRAPHS           = YES
   1.281 +UML_LOOK               = NO
   1.282 +TEMPLATE_RELATIONS     = NO
   1.283 +INCLUDE_GRAPH          = YES
   1.284 +INCLUDED_BY_GRAPH      = YES
   1.285 +CALL_GRAPH             = YES
   1.286 +CALLER_GRAPH           = NO
   1.287 +GRAPHICAL_HIERARCHY    = YES
   1.288 +DIRECTORY_GRAPH        = YES
   1.289 +DOT_IMAGE_FORMAT       = png
   1.290 +DOT_PATH               = 
   1.291 +DOTFILE_DIRS           = 
   1.292 +DOT_GRAPH_MAX_NODES    = 50
   1.293 +MAX_DOT_GRAPH_DEPTH    = 1000
   1.294 +DOT_TRANSPARENT        = YES
   1.295 +DOT_MULTI_TARGETS      = NO
   1.296 +GENERATE_LEGEND        = YES
   1.297 +DOT_CLEANUP            = YES
   1.298 +#---------------------------------------------------------------------------
   1.299 +# Configuration::additions related to the search engine   
   1.300 +#---------------------------------------------------------------------------
   1.301 +SEARCHENGINE           = NO