contrib/hostapd/doc/doxygen.fast

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