src/dom/Doxyfile

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