contrib/wpa/hostapd/doc/doxygen.full

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