reactos/lib/Doxyfile

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