doc/doxygen.cfg

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