awesome.doxygen.in

   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 INHERIT_DOCS           = YES
  30 SEPARATE_MEMBER_PAGES  = NO
  31 TAB_SIZE               = 4
  32 ALIASES                =
  33 OPTIMIZE_OUTPUT_FOR_C  = YES
  34 OPTIMIZE_OUTPUT_JAVA   = NO
  35 BUILTIN_STL_SUPPORT    = NO
  36 CPP_CLI_SUPPORT        = NO
  37 DISTRIBUTE_GROUP_DOC   = NO
  38 SUBGROUPING            = YES
  39
  40 ALIASES += luastack="\par Lua Stack:"
  41 ALIASES += lvalue="- \em value "
  42 ALIASES += lparam="- \em param "
  43 ALIASES += lreturn="- \em returns "
  44 ALIASES += lfield="- \em fields "
  45
  46 #---------------------------------------------------------------------------
  47 # Build related configuration options
  48 #---------------------------------------------------------------------------
  49 EXTRACT_ALL            = YES
  50 EXTRACT_PRIVATE        = YES
  51 EXTRACT_STATIC         = YES
  52 EXTRACT_LOCAL_CLASSES  = YES
  53 EXTRACT_LOCAL_METHODS  = YES
  54 EXTRACT_ANON_NSPACES   = YES
  55 HIDE_UNDOC_MEMBERS     = NO
  56 HIDE_UNDOC_CLASSES     = NO
  57 HIDE_FRIEND_COMPOUNDS  = NO
  58 HIDE_IN_BODY_DOCS      = NO
  59 INTERNAL_DOCS          = NO
  60 CASE_SENSE_NAMES       = YES
  61 HIDE_SCOPE_NAMES       = NO
  62 SHOW_INCLUDE_FILES     = YES
  63 INLINE_INFO            = YES
  64 SORT_MEMBER_DOCS       = YES
  65 SORT_BRIEF_DOCS        = NO
  66 SORT_BY_SCOPE_NAME     = NO
  67 GENERATE_TODOLIST      = YES
  68 GENERATE_TESTLIST      = YES
  69 GENERATE_BUGLIST       = YES
  70 GENERATE_DEPRECATEDLIST= YES
  71 ENABLED_SECTIONS       =
  72 MAX_INITIALIZER_LINES  = 30
  73 SHOW_USED_FILES        = YES
  74 SHOW_DIRECTORIES       = NO
  75 FILE_VERSION_FILTER    =
  76 #---------------------------------------------------------------------------
  77 # configuration options related to warning and progress messages
  78 #---------------------------------------------------------------------------
  79 QUIET                  = YES
  80 WARNINGS               = YES
  81 WARN_IF_UNDOCUMENTED   = YES
  82 WARN_IF_DOC_ERROR      = YES
  83 WARN_NO_PARAMDOC       = NO
  84 WARN_FORMAT            = "$file:$line: $text"
  85 WARN_LOGFILE           =
  86 #---------------------------------------------------------------------------
  87 # configuration options related to the input files
  88 #---------------------------------------------------------------------------
  89 INPUT                  = @awesome_SOURCE_DIR@
  90 INPUT_ENCODING         = UTF-8
  91 FILE_PATTERNS          = *.c \
  92                          *.h \
  93                          common/*.c \
  94                          common/*.h \
  95                          widgets/*.c \
  96                          widgets/*.h \
  97 RECURSIVE              = YES
  98 EXCLUDE                =
  99 EXCLUDE_SYMLINKS       = NO
 100 EXCLUDE_PATTERNS       =
 101 EXCLUDE_SYMBOLS        =
 102 EXAMPLE_PATH           =
 103 EXAMPLE_PATTERNS       = *
 104 EXAMPLE_RECURSIVE      = NO
 105 IMAGE_PATH             =
 106 INPUT_FILTER           =
 107 FILTER_PATTERNS        =
 108 FILTER_SOURCE_FILES    = NO
 109 #---------------------------------------------------------------------------
 110 # configuration options related to source browsing
 111 #---------------------------------------------------------------------------
 112 SOURCE_BROWSER         = YES
 113 INLINE_SOURCES         = NO
 114 STRIP_CODE_COMMENTS    = NO
 115 REFERENCED_BY_RELATION = YES
 116 REFERENCES_RELATION    = YES
 117 REFERENCES_LINK_SOURCE = YES
 118 USE_HTAGS              = NO
 119 VERBATIM_HEADERS       = YES
 120 #---------------------------------------------------------------------------
 121 # configuration options related to the alphabetical class index
 122 #---------------------------------------------------------------------------
 123 ALPHABETICAL_INDEX     = NO
 124 COLS_IN_ALPHA_INDEX    = 5
 125 IGNORE_PREFIX          =
 126 #---------------------------------------------------------------------------
 127 # configuration options related to the HTML output
 128 #---------------------------------------------------------------------------
 129 GENERATE_HTML          = YES
 130 HTML_OUTPUT            = html
 131 HTML_FILE_EXTENSION    = .html
 132 HTML_HEADER            =
 133 HTML_FOOTER            =
 134 HTML_STYLESHEET        =
 135 HTML_ALIGN_MEMBERS     = YES
 136 GENERATE_HTMLHELP      = NO
 137 HTML_DYNAMIC_SECTIONS  = NO
 138 CHM_FILE               =
 139 HHC_LOCATION           =
 140 GENERATE_CHI           = NO
 141 BINARY_TOC             = NO
 142 TOC_EXPAND             = NO
 143 DISABLE_INDEX          = NO
 144 ENUM_VALUES_PER_LINE   = 4
 145 GENERATE_TREEVIEW      = YES
 146 TREEVIEW_WIDTH         = 250
 147 #---------------------------------------------------------------------------
 148 # configuration options related to the LaTeX output
 149 #---------------------------------------------------------------------------
 150 GENERATE_LATEX         = NO
 151 LATEX_OUTPUT           = latex
 152 LATEX_CMD_NAME         = latex
 153 MAKEINDEX_CMD_NAME     = makeindex
 154 COMPACT_LATEX          = NO
 155 PAPER_TYPE             = a4wide
 156 EXTRA_PACKAGES         =
 157 LATEX_HEADER           =
 158 PDF_HYPERLINKS         = NO
 159 USE_PDFLATEX           = NO
 160 LATEX_BATCHMODE        = NO
 161 LATEX_HIDE_INDICES     = NO
 162 #---------------------------------------------------------------------------
 163 # configuration options related to the RTF output
 164 #---------------------------------------------------------------------------
 165 GENERATE_RTF           = NO
 166 RTF_OUTPUT             = rtf
 167 COMPACT_RTF            = NO
 168 RTF_HYPERLINKS         = NO
 169 RTF_STYLESHEET_FILE    =
 170 RTF_EXTENSIONS_FILE    =
 171 #---------------------------------------------------------------------------
 172 # configuration options related to the man page output
 173 #---------------------------------------------------------------------------
 174 GENERATE_MAN           = NO
 175 MAN_OUTPUT             = man
 176 MAN_EXTENSION          = .3
 177 MAN_LINKS              = NO
 178 #---------------------------------------------------------------------------
 179 # configuration options related to the XML output
 180 #---------------------------------------------------------------------------
 181 GENERATE_XML           = NO
 182 XML_OUTPUT             = xml
 183 XML_SCHEMA             =
 184 XML_DTD                =
 185 XML_PROGRAMLISTING     = YES
 186 #---------------------------------------------------------------------------
 187 # configuration options for the AutoGen Definitions output
 188 #---------------------------------------------------------------------------
 189 GENERATE_AUTOGEN_DEF   = NO
 190 #---------------------------------------------------------------------------
 191 # configuration options related to the Perl module output
 192 #---------------------------------------------------------------------------
 193 GENERATE_PERLMOD       = NO
 194 PERLMOD_LATEX          = NO
 195 PERLMOD_PRETTY         = YES
 196 PERLMOD_MAKEVAR_PREFIX =
 197 #---------------------------------------------------------------------------
 198 # Configuration options related to the preprocessor
 199 #---------------------------------------------------------------------------
 200 ENABLE_PREPROCESSING   = YES
 201 MACRO_EXPANSION        = YES
 202 EXPAND_ONLY_PREDEF     = YES
 203 SEARCH_INCLUDES        = YES
 204 INCLUDE_PATH           =
 205 INCLUDE_FILE_PATTERNS  =
 206 PREDEFINED             = "__attribute__(x)="
 207 EXPAND_AS_DEFINED      =
 208 SKIP_FUNCTION_MACROS   = YES
 209 #---------------------------------------------------------------------------
 210 # Configuration::additions related to external references
 211 #---------------------------------------------------------------------------
 212 TAGFILES               =
 213 GENERATE_TAGFILE       =
 214 ALLEXTERNALS           = NO
 215 EXTERNAL_GROUPS        = YES
 216 PERL_PATH              = /usr/bin/perl
 217 #---------------------------------------------------------------------------
 218 # Configuration options related to the dot tool
 219 #---------------------------------------------------------------------------
 220 CLASS_DIAGRAMS         = NO
 221 MSCGEN_PATH            =
 222 HIDE_UNDOC_RELATIONS   = YES
 223 HAVE_DOT               = YES
 224 CLASS_GRAPH            = YES
 225 COLLABORATION_GRAPH    = YES
 226 GROUP_GRAPHS           = YES
 227 UML_LOOK               = YES
 228 TEMPLATE_RELATIONS     = YeS
 229 INCLUDE_GRAPH          = YES
 230 INCLUDED_BY_GRAPH      = YES
 231 CALL_GRAPH             = YES
 232 CALLER_GRAPH           = YES
 233 GRAPHICAL_HIERARCHY    = YES
 234 DIRECTORY_GRAPH        = YES
 235 DOT_IMAGE_FORMAT       = png
 236 DOT_PATH               =
 237 DOTFILE_DIRS           =
 238 DOT_GRAPH_MAX_NODES    = 50
 239 MAX_DOT_GRAPH_DEPTH    = 1000
 240 DOT_TRANSPARENT        = NO
 241 DOT_MULTI_TARGETS      = NO
 242 GENERATE_LEGEND        = YES
 243 DOT_CLEANUP            = YES
 244 #---------------------------------------------------------------------------
 245 # Configuration::additions related to the search engine
 246 #---------------------------------------------------------------------------
 247 SEARCHENGINE           = NO