contrib/wpa_supplicant/doc/doxygen.fast

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