awesome.doxygen

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