doc/Doxyfile

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