docs/doxyfile

   1 # Doxyfile 1.7.4
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = "cryptsetup API"
   8 PROJECT_NUMBER         =
   9 PROJECT_BRIEF          = "Public cryptsetup API"
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       = doxygen_api_docs
  12 CREATE_SUBDIRS         = NO
  13 OUTPUT_LANGUAGE        = English
  14 BRIEF_MEMBER_DESC      = YES
  15 REPEAT_BRIEF           = YES
  16 ABBREVIATE_BRIEF       =
  17 ALWAYS_DETAILED_SEC    = NO
  18 INLINE_INHERITED_MEMB  = NO
  19 FULL_PATH_NAMES        = YES
  20 STRIP_FROM_PATH        =
  21 STRIP_FROM_INC_PATH    =
  22 SHORT_NAMES            = NO
  23 JAVADOC_AUTOBRIEF      = NO
  24 QT_AUTOBRIEF           = NO
  25 MULTILINE_CPP_IS_BRIEF = NO
  26 INHERIT_DOCS           = YES
  27 SEPARATE_MEMBER_PAGES  = NO
  28 TAB_SIZE               = 8
  29 ALIASES                =
  30 OPTIMIZE_OUTPUT_FOR_C  = YES
  31 OPTIMIZE_OUTPUT_JAVA   = NO
  32 OPTIMIZE_FOR_FORTRAN   = NO
  33 OPTIMIZE_OUTPUT_VHDL   = NO
  34 EXTENSION_MAPPING      =
  35 BUILTIN_STL_SUPPORT    = NO
  36 CPP_CLI_SUPPORT        = NO
  37 SIP_SUPPORT            = NO
  38 IDL_PROPERTY_SUPPORT   = YES
  39 DISTRIBUTE_GROUP_DOC   = NO
  40 SUBGROUPING            = YES
  41 INLINE_GROUPED_CLASSES = NO
  42 TYPEDEF_HIDES_STRUCT   = YES
  43 SYMBOL_CACHE_SIZE      = 0
  44 #---------------------------------------------------------------------------
  45 # Build related configuration options
  46 #---------------------------------------------------------------------------
  47 EXTRACT_ALL            = NO
  48 EXTRACT_PRIVATE        = NO
  49 EXTRACT_STATIC         = NO
  50 EXTRACT_LOCAL_CLASSES  = YES
  51 EXTRACT_LOCAL_METHODS  = NO
  52 EXTRACT_ANON_NSPACES   = NO
  53 HIDE_UNDOC_MEMBERS     = NO
  54 HIDE_UNDOC_CLASSES     = NO
  55 HIDE_FRIEND_COMPOUNDS  = NO
  56 HIDE_IN_BODY_DOCS      = NO
  57 INTERNAL_DOCS          = NO
  58 CASE_SENSE_NAMES       = YES
  59 HIDE_SCOPE_NAMES       = NO
  60 SHOW_INCLUDE_FILES     = YES
  61 FORCE_LOCAL_INCLUDES   = NO
  62 INLINE_INFO            = YES
  63 SORT_MEMBER_DOCS       = YES
  64 SORT_BRIEF_DOCS        = NO
  65 SORT_MEMBERS_CTORS_1ST = NO
  66 SORT_GROUP_NAMES       = NO
  67 SORT_BY_SCOPE_NAME     = NO
  68 STRICT_PROTO_MATCHING  = NO
  69 GENERATE_TODOLIST      = YES
  70 GENERATE_TESTLIST      = YES
  71 GENERATE_BUGLIST       = YES
  72 GENERATE_DEPRECATEDLIST= YES
  73 ENABLED_SECTIONS       =
  74 MAX_INITIALIZER_LINES  = 30
  75 SHOW_USED_FILES        = YES
  76 SHOW_DIRECTORIES       = NO
  77 SHOW_FILES             = YES
  78 SHOW_NAMESPACES        = YES
  79 FILE_VERSION_FILTER    =
  80 LAYOUT_FILE            =
  81 #---------------------------------------------------------------------------
  82 # configuration options related to warning and progress messages
  83 #---------------------------------------------------------------------------
  84 QUIET                  = NO
  85 WARNINGS               = YES
  86 WARN_IF_UNDOCUMENTED   = YES
  87 WARN_IF_DOC_ERROR      = YES
  88 WARN_NO_PARAMDOC       = NO
  89 WARN_FORMAT            = "$file:$line: $text"
  90 WARN_LOGFILE           =
  91 #---------------------------------------------------------------------------
  92 # configuration options related to the input files
  93 #---------------------------------------------------------------------------
  94 INPUT                  = "doxygen_index" "../lib/libcryptsetup.h"
  95 INPUT_ENCODING         = UTF-8
  96 FILE_PATTERNS          =
  97 RECURSIVE              = NO
  98 EXCLUDE                =
  99 EXCLUDE_SYMLINKS       = NO
 100 EXCLUDE_PATTERNS       =
 101 EXCLUDE_SYMBOLS        =
 102 EXAMPLE_PATH           = "examples"
 103 EXAMPLE_PATTERNS       =
 104 EXAMPLE_RECURSIVE      = NO
 105 IMAGE_PATH             =
 106 INPUT_FILTER           =
 107 FILTER_PATTERNS        =
 108 FILTER_SOURCE_FILES    = NO
 109 FILTER_SOURCE_PATTERNS =
 110 #---------------------------------------------------------------------------
 111 # configuration options related to source browsing
 112 #---------------------------------------------------------------------------
 113 SOURCE_BROWSER         = NO
 114 INLINE_SOURCES         = NO
 115 STRIP_CODE_COMMENTS    = YES
 116 REFERENCED_BY_RELATION = NO
 117 REFERENCES_RELATION    = NO
 118 REFERENCES_LINK_SOURCE = YES
 119 USE_HTAGS              = NO
 120 VERBATIM_HEADERS       = YES
 121 #---------------------------------------------------------------------------
 122 # configuration options related to the alphabetical class index
 123 #---------------------------------------------------------------------------
 124 ALPHABETICAL_INDEX     = YES
 125 COLS_IN_ALPHA_INDEX    = 5
 126 IGNORE_PREFIX          =
 127 #---------------------------------------------------------------------------
 128 # configuration options related to the HTML output
 129 #---------------------------------------------------------------------------
 130 GENERATE_HTML          = YES
 131 HTML_OUTPUT            = html
 132 HTML_FILE_EXTENSION    = .html
 133 HTML_HEADER            =
 134 HTML_FOOTER            =
 135 HTML_STYLESHEET        =
 136 HTML_EXTRA_FILES       =
 137 HTML_COLORSTYLE_HUE    = 220
 138 HTML_COLORSTYLE_SAT    = 100
 139 HTML_COLORSTYLE_GAMMA  = 80
 140 HTML_TIMESTAMP         = YES
 141 HTML_ALIGN_MEMBERS     = YES
 142 HTML_DYNAMIC_SECTIONS  = NO
 143 GENERATE_DOCSET        = NO
 144 DOCSET_FEEDNAME        = "Doxygen generated docs"
 145 DOCSET_BUNDLE_ID       = org.doxygen.Project
 146 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 147 DOCSET_PUBLISHER_NAME  = Publisher
 148 GENERATE_HTMLHELP      = NO
 149 CHM_FILE               =
 150 HHC_LOCATION           =
 151 GENERATE_CHI           = NO
 152 CHM_INDEX_ENCODING     =
 153 BINARY_TOC             = NO
 154 TOC_EXPAND             = NO
 155 GENERATE_QHP           = NO
 156 QCH_FILE               =
 157 QHP_NAMESPACE          = org.doxygen.Project
 158 QHP_VIRTUAL_FOLDER     = doc
 159 QHP_CUST_FILTER_NAME   =
 160 QHP_CUST_FILTER_ATTRS  =
 161 QHP_SECT_FILTER_ATTRS  =
 162 QHG_LOCATION           =
 163 GENERATE_ECLIPSEHELP   = NO
 164 ECLIPSE_DOC_ID         = org.doxygen.Project
 165 DISABLE_INDEX          = NO
 166 ENUM_VALUES_PER_LINE   = 4
 167 GENERATE_TREEVIEW      = NO
 168 USE_INLINE_TREES       = NO
 169 TREEVIEW_WIDTH         = 250
 170 EXT_LINKS_IN_WINDOW    = NO
 171 FORMULA_FONTSIZE       = 10
 172 FORMULA_TRANSPARENT    = YES
 173 USE_MATHJAX            = NO
 174 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 175 SEARCHENGINE           = YES
 176 SERVER_BASED_SEARCH    = NO
 177 #---------------------------------------------------------------------------
 178 # configuration options related to the LaTeX output
 179 #---------------------------------------------------------------------------
 180 GENERATE_LATEX         = YES
 181 LATEX_OUTPUT           = latex
 182 LATEX_CMD_NAME         = latex
 183 MAKEINDEX_CMD_NAME     = makeindex
 184 COMPACT_LATEX          = NO
 185 PAPER_TYPE             = a4
 186 EXTRA_PACKAGES         =
 187 LATEX_HEADER           =
 188 LATEX_FOOTER           =
 189 PDF_HYPERLINKS         = YES
 190 USE_PDFLATEX           = YES
 191 LATEX_BATCHMODE        = NO
 192 LATEX_HIDE_INDICES     = NO
 193 LATEX_SOURCE_CODE      = NO
 194 #---------------------------------------------------------------------------
 195 # configuration options related to the RTF output
 196 #---------------------------------------------------------------------------
 197 GENERATE_RTF           = NO
 198 RTF_OUTPUT             = rtf
 199 COMPACT_RTF            = NO
 200 RTF_HYPERLINKS         = NO
 201 RTF_STYLESHEET_FILE    =
 202 RTF_EXTENSIONS_FILE    =
 203 #---------------------------------------------------------------------------
 204 # configuration options related to the man page output
 205 #---------------------------------------------------------------------------
 206 GENERATE_MAN           = NO
 207 MAN_OUTPUT             = man
 208 MAN_EXTENSION          = .3
 209 MAN_LINKS              = NO
 210 #---------------------------------------------------------------------------
 211 # configuration options related to the XML output
 212 #---------------------------------------------------------------------------
 213 GENERATE_XML           = NO
 214 XML_OUTPUT             = xml
 215 XML_SCHEMA             =
 216 XML_DTD                =
 217 XML_PROGRAMLISTING     = YES
 218 #---------------------------------------------------------------------------
 219 # configuration options for the AutoGen Definitions output
 220 #---------------------------------------------------------------------------
 221 GENERATE_AUTOGEN_DEF   = NO
 222 #---------------------------------------------------------------------------
 223 # configuration options related to the Perl module output
 224 #---------------------------------------------------------------------------
 225 GENERATE_PERLMOD       = NO
 226 PERLMOD_LATEX          = NO
 227 PERLMOD_PRETTY         = YES
 228 PERLMOD_MAKEVAR_PREFIX =
 229 #---------------------------------------------------------------------------
 230 # Configuration options related to the preprocessor
 231 #---------------------------------------------------------------------------
 232 ENABLE_PREPROCESSING   = YES
 233 MACRO_EXPANSION        = NO
 234 EXPAND_ONLY_PREDEF     = NO
 235 SEARCH_INCLUDES        = YES
 236 INCLUDE_PATH           =
 237 INCLUDE_FILE_PATTERNS  =
 238 PREDEFINED             =
 239 EXPAND_AS_DEFINED      =
 240 SKIP_FUNCTION_MACROS   = YES
 241 #---------------------------------------------------------------------------
 242 # Configuration::additions related to external references
 243 #---------------------------------------------------------------------------
 244 TAGFILES               =
 245 GENERATE_TAGFILE       =
 246 ALLEXTERNALS           = NO
 247 EXTERNAL_GROUPS        = YES
 248 PERL_PATH              =
 249 #---------------------------------------------------------------------------
 250 # Configuration options related to the dot tool
 251 #---------------------------------------------------------------------------
 252 CLASS_DIAGRAMS         = YES
 253 MSCGEN_PATH            =
 254 HIDE_UNDOC_RELATIONS   = YES
 255 HAVE_DOT               = NO
 256 DOT_NUM_THREADS        = 0
 257 DOT_FONTNAME           = Helvetica
 258 DOT_FONTSIZE           = 10
 259 DOT_FONTPATH           =
 260 CLASS_GRAPH            = YES
 261 COLLABORATION_GRAPH    = YES
 262 GROUP_GRAPHS           = YES
 263 UML_LOOK               = NO
 264 TEMPLATE_RELATIONS     = NO
 265 INCLUDE_GRAPH          = YES
 266 INCLUDED_BY_GRAPH      = YES
 267 CALL_GRAPH             = NO
 268 CALLER_GRAPH           = NO
 269 GRAPHICAL_HIERARCHY    = YES
 270 DIRECTORY_GRAPH        = YES
 271 DOT_IMAGE_FORMAT       = png
 272 DOT_PATH               =
 273 DOTFILE_DIRS           =
 274 MSCFILE_DIRS           =
 275 DOT_GRAPH_MAX_NODES    = 50
 276 MAX_DOT_GRAPH_DEPTH    = 0
 277 DOT_TRANSPARENT        = NO
 278 DOT_MULTI_TARGETS      = NO
 279 GENERATE_LEGEND        = YES
 280 DOT_CLEANUP            = YES