docs/doxyfile

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