Doxyfile

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