doc/Doxyfile.in

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