contrib/wpa/wpa_supplicant/doc/doxygen.fast

   1 # Doxyfile 1.4.4
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = wpa_supplicant
   7 PROJECT_NUMBER         = 0.6.x
   8 OUTPUT_DIRECTORY       = wpa_supplicant/doc
   9 CREATE_SUBDIRS         = NO
  10 OUTPUT_LANGUAGE        = English
  11 BRIEF_MEMBER_DESC      = YES
  12 REPEAT_BRIEF           = YES
  13 ABBREVIATE_BRIEF       = "The $name class" \
  14                          "The $name widget" \
  15                          "The $name file" \
  16                          is \
  17                          provides \
  18                          specifies \
  19                          contains \
  20                          represents \
  21                          a \
  22                          an \
  23                          the
  24 ALWAYS_DETAILED_SEC    = NO
  25 INLINE_INHERITED_MEMB  = NO
  26 FULL_PATH_NAMES        = YES
  27 STRIP_FROM_PATH        =
  28 STRIP_FROM_INC_PATH    =
  29 SHORT_NAMES            = NO
  30 JAVADOC_AUTOBRIEF      = NO
  31 MULTILINE_CPP_IS_BRIEF = NO
  32 DETAILS_AT_TOP         = NO
  33 INHERIT_DOCS           = YES
  34 DISTRIBUTE_GROUP_DOC   = NO
  35 SEPARATE_MEMBER_PAGES  = 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       = YES
  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   = NO
  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                  = wpa_supplicant \
  84         src/common \
  85         src/crypto \
  86         src/drivers \
  87         src/eap_common \
  88         src/eapol_supp \
  89         src/eap_peer \
  90         src/l2_packet \
  91         src/rsn_supp \
  92         src/tls \
  93         src/utils \
  94         src/wps
  95 FILE_PATTERNS          = *.c *.h *.cpp *.m *.doxygen
  96 RECURSIVE              = YES
  97 EXCLUDE                = wpa_supplicant/wpa_gui
  98 EXCLUDE_SYMLINKS       = NO
  99 EXCLUDE_PATTERNS       = */.moc/* */.ui/*
 100 EXAMPLE_PATH           =
 101 EXAMPLE_PATTERNS       = *
 102 EXAMPLE_RECURSIVE      = NO
 103 IMAGE_PATH             = wpa_supplicant/doc
 104 INPUT_FILTER           = kerneldoc2doxygen.pl
 105 FILTER_PATTERNS        =
 106 FILTER_SOURCE_FILES    = YES
 107 #---------------------------------------------------------------------------
 108 # configuration options related to source browsing
 109 #---------------------------------------------------------------------------
 110 SOURCE_BROWSER         = YES
 111 INLINE_SOURCES         = NO
 112 STRIP_CODE_COMMENTS    = YES
 113 REFERENCED_BY_RELATION = NO
 114 REFERENCES_RELATION    = NO
 115 VERBATIM_HEADERS       = NO
 116 #---------------------------------------------------------------------------
 117 # configuration options related to the alphabetical class index
 118 #---------------------------------------------------------------------------
 119 ALPHABETICAL_INDEX     = YES
 120 COLS_IN_ALPHA_INDEX    = 3
 121 IGNORE_PREFIX          =
 122 #---------------------------------------------------------------------------
 123 # configuration options related to the HTML output
 124 #---------------------------------------------------------------------------
 125 GENERATE_HTML          = YES
 126 HTML_OUTPUT            = html
 127 HTML_FILE_EXTENSION    = .html
 128 HTML_HEADER            =
 129 HTML_FOOTER            =
 130 HTML_STYLESHEET        =
 131 HTML_ALIGN_MEMBERS     = YES
 132 GENERATE_HTMLHELP      = NO
 133 CHM_FILE               =
 134 HHC_LOCATION           =
 135 GENERATE_CHI           = NO
 136 BINARY_TOC             = NO
 137 TOC_EXPAND             = NO
 138 DISABLE_INDEX          = NO
 139 ENUM_VALUES_PER_LINE   = 4
 140 GENERATE_TREEVIEW      = NO
 141 TREEVIEW_WIDTH         = 250
 142 #---------------------------------------------------------------------------
 143 # configuration options related to the LaTeX output
 144 #---------------------------------------------------------------------------
 145 GENERATE_LATEX         = NO
 146 LATEX_OUTPUT           = latex
 147 LATEX_CMD_NAME         = latex
 148 MAKEINDEX_CMD_NAME     = makeindex
 149 COMPACT_LATEX          = NO
 150 PAPER_TYPE             = a4wide
 151 EXTRA_PACKAGES         =
 152 LATEX_HEADER           =
 153 PDF_HYPERLINKS         = YES
 154 USE_PDFLATEX           = YES
 155 LATEX_BATCHMODE        = NO
 156 LATEX_HIDE_INDICES     = NO
 157 #---------------------------------------------------------------------------
 158 # configuration options related to the RTF output
 159 #---------------------------------------------------------------------------
 160 GENERATE_RTF           = NO
 161 RTF_OUTPUT             = rtf
 162 COMPACT_RTF            = NO
 163 RTF_HYPERLINKS         = NO
 164 RTF_STYLESHEET_FILE    =
 165 RTF_EXTENSIONS_FILE    =
 166 #---------------------------------------------------------------------------
 167 # configuration options related to the man page output
 168 #---------------------------------------------------------------------------
 169 GENERATE_MAN           = NO
 170 MAN_OUTPUT             = man
 171 MAN_EXTENSION          = .3
 172 MAN_LINKS              = NO
 173 #---------------------------------------------------------------------------
 174 # configuration options related to the XML output
 175 #---------------------------------------------------------------------------
 176 GENERATE_XML           = NO
 177 XML_OUTPUT             = xml
 178 XML_SCHEMA             =
 179 XML_DTD                =
 180 XML_PROGRAMLISTING     = YES
 181 #---------------------------------------------------------------------------
 182 # configuration options for the AutoGen Definitions output
 183 #---------------------------------------------------------------------------
 184 GENERATE_AUTOGEN_DEF   = NO
 185 #---------------------------------------------------------------------------
 186 # configuration options related to the Perl module output
 187 #---------------------------------------------------------------------------
 188 GENERATE_PERLMOD       = NO
 189 PERLMOD_LATEX          = NO
 190 PERLMOD_PRETTY         = YES
 191 PERLMOD_MAKEVAR_PREFIX =
 192 #---------------------------------------------------------------------------
 193 # Configuration options related to the preprocessor
 194 #---------------------------------------------------------------------------
 195 ENABLE_PREPROCESSING   = YES
 196 MACRO_EXPANSION        = NO
 197 EXPAND_ONLY_PREDEF     = NO
 198 SEARCH_INCLUDES        = YES
 199 INCLUDE_PATH           =
 200 INCLUDE_FILE_PATTERNS  =
 201 PREDEFINED             = IEEE8021X_EAPOL CONFIG_CTRL_IFACE
 202 EXPAND_AS_DEFINED      =
 203 SKIP_FUNCTION_MACROS   = YES
 204 #---------------------------------------------------------------------------
 205 # Configuration::additions related to external references
 206 #---------------------------------------------------------------------------
 207 TAGFILES               =
 208 GENERATE_TAGFILE       =
 209 ALLEXTERNALS           = NO
 210 EXTERNAL_GROUPS        = YES
 211 PERL_PATH              = /usr/bin/perl
 212 #---------------------------------------------------------------------------
 213 # Configuration options related to the dot tool
 214 #---------------------------------------------------------------------------
 215 CLASS_DIAGRAMS         = NO
 216 HIDE_UNDOC_RELATIONS   = YES
 217 HAVE_DOT               = NO
 218 CLASS_GRAPH            = YES
 219 COLLABORATION_GRAPH    = YES
 220 GROUP_GRAPHS           = YES
 221 UML_LOOK               = NO
 222 TEMPLATE_RELATIONS     = NO
 223 INCLUDE_GRAPH          = YES
 224 INCLUDED_BY_GRAPH      = YES
 225 CALL_GRAPH             = YES
 226 GRAPHICAL_HIERARCHY    = YES
 227 DIRECTORY_GRAPH        = NO
 228 DOT_IMAGE_FORMAT       = png
 229 DOT_PATH               =
 230 DOTFILE_DIRS           =
 231 MAX_DOT_GRAPH_DEPTH    = 1000
 232 DOT_TRANSPARENT        = NO
 233 DOT_MULTI_TARGETS      = NO
 234 GENERATE_LEGEND        = YES
 235 DOT_CLEANUP            = YES
 236 #---------------------------------------------------------------------------
 237 # Configuration::additions related to the search engine
 238 #---------------------------------------------------------------------------
 239 SEARCHENGINE           = NO