docs/doxyfile

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