Routix/doc/documentation

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