reactos/subsys/system/explorer/Doxyfile

   1 # Doxyfile 1.3.4
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "ROS Explorer"
   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        = NO
  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           = YES
  22 DISTRIBUTE_GROUP_DOC   = NO
  23 TAB_SIZE               = 8
  24 ALIASES                =
  25 OPTIMIZE_OUTPUT_FOR_C  = NO
  26 OPTIMIZE_OUTPUT_JAVA   = NO
  27 SUBGROUPING            = YES
  28 #---------------------------------------------------------------------------
  29 # Build related configuration options
  30 #---------------------------------------------------------------------------
  31 EXTRACT_ALL            = NO
  32 EXTRACT_PRIVATE        = NO
  33 EXTRACT_STATIC         = NO
  34 EXTRACT_LOCAL_CLASSES  = YES
  35 HIDE_UNDOC_MEMBERS     = NO
  36 HIDE_UNDOC_CLASSES     = NO
  37 HIDE_FRIEND_COMPOUNDS  = NO
  38 HIDE_IN_BODY_DOCS      = NO
  39 INTERNAL_DOCS          = NO
  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               = YES
  57 WARN_IF_UNDOCUMENTED   = YES
  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                          desktop \
  66                          dialogs \
  67                          shell \
  68                          taskbar \
  69                          utility
  70 FILE_PATTERNS          = *.cpp \
  71                          *.c \
  72                          *.hpp \
  73                          *.h
  74 RECURSIVE              = NO
  75 EXCLUDE                =
  76 EXCLUDE_SYMLINKS       = NO
  77 EXCLUDE_PATTERNS       =
  78 EXAMPLE_PATH           =
  79 EXAMPLE_PATTERNS       =
  80 EXAMPLE_RECURSIVE      = NO
  81 IMAGE_PATH             =
  82 INPUT_FILTER           =
  83 FILTER_SOURCE_FILES    = NO
  84 #---------------------------------------------------------------------------
  85 # configuration options related to source browsing
  86 #---------------------------------------------------------------------------
  87 SOURCE_BROWSER         = YES
  88 INLINE_SOURCES         = YES
  89 STRIP_CODE_COMMENTS    = YES
  90 REFERENCED_BY_RELATION = YES
  91 REFERENCES_RELATION    = YES
  92 VERBATIM_HEADERS       = YES
  93 #---------------------------------------------------------------------------
  94 # configuration options related to the alphabetical class index
  95 #---------------------------------------------------------------------------
  96 ALPHABETICAL_INDEX     = YES
  97 COLS_IN_ALPHA_INDEX    = 5
  98 IGNORE_PREFIX          =
  99 #---------------------------------------------------------------------------
 100 # configuration options related to the HTML output
 101 #---------------------------------------------------------------------------
 102 GENERATE_HTML          = YES
 103 HTML_OUTPUT            = html
 104 HTML_FILE_EXTENSION    = .html
 105 HTML_HEADER            =
 106 HTML_FOOTER            = doxy-footer.html
 107 HTML_STYLESHEET        =
 108 HTML_ALIGN_MEMBERS     = YES
 109 GENERATE_HTMLHELP      = YES
 110 CHM_FILE               =
 111 HHC_LOCATION           =
 112 GENERATE_CHI           = NO
 113 BINARY_TOC             = NO
 114 TOC_EXPAND             = NO
 115 DISABLE_INDEX          = NO
 116 ENUM_VALUES_PER_LINE   = 4
 117 GENERATE_TREEVIEW      = YES
 118 TREEVIEW_WIDTH         = 250
 119 #---------------------------------------------------------------------------
 120 # configuration options related to the LaTeX output
 121 #---------------------------------------------------------------------------
 122 GENERATE_LATEX         = NO
 123 LATEX_OUTPUT           = latex
 124 LATEX_CMD_NAME         = latex
 125 MAKEINDEX_CMD_NAME     = makeindex
 126 COMPACT_LATEX          = NO
 127 PAPER_TYPE             = a4wide
 128 EXTRA_PACKAGES         =
 129 LATEX_HEADER           =
 130 PDF_HYPERLINKS         = NO
 131 USE_PDFLATEX           = NO
 132 LATEX_BATCHMODE        = NO
 133 LATEX_HIDE_INDICES     = NO
 134 #---------------------------------------------------------------------------
 135 # configuration options related to the RTF output
 136 #---------------------------------------------------------------------------
 137 GENERATE_RTF           = NO
 138 RTF_OUTPUT             = rtf
 139 COMPACT_RTF            = YES
 140 RTF_HYPERLINKS         = YES
 141 RTF_STYLESHEET_FILE    =
 142 RTF_EXTENSIONS_FILE    =
 143 #---------------------------------------------------------------------------
 144 # configuration options related to the man page output
 145 #---------------------------------------------------------------------------
 146 GENERATE_MAN           = NO
 147 MAN_OUTPUT             = man
 148 MAN_EXTENSION          = .3
 149 MAN_LINKS              = NO
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the XML output
 152 #---------------------------------------------------------------------------
 153 GENERATE_XML           = NO
 154 XML_OUTPUT             = xml
 155 XML_SCHEMA             =
 156 XML_DTD                =
 157 #---------------------------------------------------------------------------
 158 # configuration options for the AutoGen Definitions output
 159 #---------------------------------------------------------------------------
 160 GENERATE_AUTOGEN_DEF   = NO
 161 #---------------------------------------------------------------------------
 162 # configuration options related to the Perl module output
 163 #---------------------------------------------------------------------------
 164 GENERATE_PERLMOD       = NO
 165 PERLMOD_LATEX          = NO
 166 PERLMOD_PRETTY         = YES
 167 PERLMOD_MAKEVAR_PREFIX =
 168 #---------------------------------------------------------------------------
 169 # Configuration options related to the preprocessor
 170 #---------------------------------------------------------------------------
 171 ENABLE_PREPROCESSING   = YES
 172 MACRO_EXPANSION        = NO
 173 EXPAND_ONLY_PREDEF     = NO
 174 SEARCH_INCLUDES        = YES
 175 INCLUDE_PATH           =
 176 INCLUDE_FILE_PATTERNS  =
 177 PREDEFINED             = __cplusplus
 178 EXPAND_AS_DEFINED      =
 179 SKIP_FUNCTION_MACROS   = YES
 180 #---------------------------------------------------------------------------
 181 # Configuration::addtions related to external references
 182 #---------------------------------------------------------------------------
 183 TAGFILES               =
 184 GENERATE_TAGFILE       =
 185 ALLEXTERNALS           = NO
 186 EXTERNAL_GROUPS        = YES
 187 PERL_PATH              = /usr/bin/perl
 188 #---------------------------------------------------------------------------
 189 # Configuration options related to the dot tool
 190 #---------------------------------------------------------------------------
 191 CLASS_DIAGRAMS         = YES
 192 HIDE_UNDOC_RELATIONS   = NO
 193 HAVE_DOT               = YES
 194 CLASS_GRAPH            = YES
 195 COLLABORATION_GRAPH    = YES
 196 UML_LOOK               = NO
 197 TEMPLATE_RELATIONS     = NO
 198 INCLUDE_GRAPH          = YES
 199 INCLUDED_BY_GRAPH      = YES
 200 CALL_GRAPH             = YES
 201 GRAPHICAL_HIERARCHY    = YES
 202 DOT_IMAGE_FORMAT       = png
 203 DOT_PATH               =
 204 DOTFILE_DIRS           =
 205 MAX_DOT_GRAPH_WIDTH    = 1024
 206 MAX_DOT_GRAPH_HEIGHT   = 1024
 207 MAX_DOT_GRAPH_DEPTH    = 0
 208 GENERATE_LEGEND        = YES
 209 DOT_CLEANUP            = YES
 210 #---------------------------------------------------------------------------
 211 # Configuration::addtions related to the search engine
 212 #---------------------------------------------------------------------------
 213 SEARCHENGINE           = NO