contrib/hostapd/doc/doxygen.full

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