doc/Doxyfile

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