nel/doc/nel.dox

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