Doxyfile

Thu, 25 Sep 2008 15:29:35 +0100

author
Philip Pemberton <philpem@philpem.me.uk>
date
Thu, 25 Sep 2008 15:29:35 +0100
changeset 11
bfaaf539bc4d
parent 7
3a75ccaaa1ac
permissions
-rw-r--r--

Added lpfkbinclock test program (from Ethan Dicks, ethan.dicks usap.gov)

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