docs/Doxyfile

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