doc/Doxyfile

   1 # Doxyfile 1.5.5
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = libalpm
   8 PROJECT_NUMBER         =
   9 OUTPUT_DIRECTORY       = ./
  10 CREATE_SUBDIRS         = NO
  11 OUTPUT_LANGUAGE        = English
  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    = YES
  26 INLINE_INHERITED_MEMB  = NO
  27 FULL_PATH_NAMES        = NO
  28 STRIP_FROM_PATH        =
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = NO
  31 JAVADOC_AUTOBRIEF      = YES
  32 QT_AUTOBRIEF           = NO
  33 MULTILINE_CPP_IS_BRIEF = NO
  34 DETAILS_AT_TOP         = NO
  35 INHERIT_DOCS           = YES
  36 SEPARATE_MEMBER_PAGES  = NO
  37 TAB_SIZE               = 4
  38 ALIASES                =
  39 OPTIMIZE_OUTPUT_FOR_C  = YES
  40 OPTIMIZE_OUTPUT_JAVA   = NO
  41 OPTIMIZE_FOR_FORTRAN   = NO
  42 OPTIMIZE_OUTPUT_VHDL   = NO
  43 BUILTIN_STL_SUPPORT    = NO
  44 CPP_CLI_SUPPORT        = NO
  45 SIP_SUPPORT            = NO
  46 DISTRIBUTE_GROUP_DOC   = NO
  47 SUBGROUPING            = YES
  48 TYPEDEF_HIDES_STRUCT   = NO
  49 #---------------------------------------------------------------------------
  50 # Build related configuration options
  51 #---------------------------------------------------------------------------
  52 EXTRACT_ALL            = NO
  53 EXTRACT_PRIVATE        = NO
  54 EXTRACT_STATIC         = NO
  55 EXTRACT_LOCAL_CLASSES  = YES
  56 EXTRACT_LOCAL_METHODS  = NO
  57 EXTRACT_ANON_NSPACES   = NO
  58 HIDE_UNDOC_MEMBERS     = NO
  59 HIDE_UNDOC_CLASSES     = NO
  60 HIDE_FRIEND_COMPOUNDS  = NO
  61 HIDE_IN_BODY_DOCS      = YES
  62 INTERNAL_DOCS          = NO
  63 CASE_SENSE_NAMES       = YES
  64 HIDE_SCOPE_NAMES       = NO
  65 SHOW_INCLUDE_FILES     = YES
  66 INLINE_INFO            = YES
  67 SORT_MEMBER_DOCS       = YES
  68 SORT_BRIEF_DOCS        = NO
  69 SORT_GROUP_NAMES       = NO
  70 SORT_BY_SCOPE_NAME     = NO
  71 GENERATE_TODOLIST      = YES
  72 GENERATE_TESTLIST      = YES
  73 GENERATE_BUGLIST       = YES
  74 GENERATE_DEPRECATEDLIST= YES
  75 ENABLED_SECTIONS       =
  76 MAX_INITIALIZER_LINES  = 30
  77 SHOW_USED_FILES        = YES
  78 SHOW_DIRECTORIES       = NO
  79 FILE_VERSION_FILTER    =
  80 #---------------------------------------------------------------------------
  81 # configuration options related to warning and progress messages
  82 #---------------------------------------------------------------------------
  83 QUIET                  = NO
  84 WARNINGS               = YES
  85 WARN_IF_UNDOCUMENTED   = YES
  86 WARN_IF_DOC_ERROR      = YES
  87 WARN_NO_PARAMDOC       = NO
  88 WARN_FORMAT            = "$file:$line: $text"
  89 WARN_LOGFILE           =
  90 #---------------------------------------------------------------------------
  91 # configuration options related to the input files
  92 #---------------------------------------------------------------------------
  93 INPUT                  = ../lib/libalpm/
  94 INPUT_ENCODING         = UTF-8
  95 FILE_PATTERNS          =
  96 RECURSIVE              = NO
  97 EXCLUDE                =
  98 EXCLUDE_SYMLINKS       = NO
  99 EXCLUDE_PATTERNS       =
 100 EXCLUDE_SYMBOLS        =
 101 EXAMPLE_PATH           =
 102 EXAMPLE_PATTERNS       = *
 103 EXAMPLE_RECURSIVE      = NO
 104 IMAGE_PATH             =
 105 INPUT_FILTER           =
 106 FILTER_PATTERNS        =
 107 FILTER_SOURCE_FILES    = NO
 108 #---------------------------------------------------------------------------
 109 # configuration options related to source browsing
 110 #---------------------------------------------------------------------------
 111 SOURCE_BROWSER         = NO
 112 INLINE_SOURCES         = NO
 113 STRIP_CODE_COMMENTS    = NO
 114 REFERENCED_BY_RELATION = YES
 115 REFERENCES_RELATION    = YES
 116 REFERENCES_LINK_SOURCE = YES
 117 USE_HTAGS              = NO
 118 VERBATIM_HEADERS       = YES
 119 #---------------------------------------------------------------------------
 120 # configuration options related to the alphabetical class index
 121 #---------------------------------------------------------------------------
 122 ALPHABETICAL_INDEX     = NO
 123 COLS_IN_ALPHA_INDEX    = 5
 124 IGNORE_PREFIX          =
 125 #---------------------------------------------------------------------------
 126 # configuration options related to the HTML output
 127 #---------------------------------------------------------------------------
 128 GENERATE_HTML          = NO
 129 HTML_OUTPUT            = html
 130 HTML_FILE_EXTENSION    = .html
 131 HTML_HEADER            =
 132 HTML_FOOTER            =
 133 HTML_STYLESHEET        =
 134 HTML_ALIGN_MEMBERS     = YES
 135 GENERATE_HTMLHELP      = NO
 136 GENERATE_DOCSET        = NO
 137 DOCSET_FEEDNAME        = "Doxygen generated docs"
 138 DOCSET_BUNDLE_ID       = org.doxygen.Project
 139 HTML_DYNAMIC_SECTIONS  = NO
 140 CHM_FILE               =
 141 HHC_LOCATION           =
 142 GENERATE_CHI           = NO
 143 BINARY_TOC             = NO
 144 TOC_EXPAND             = NO
 145 DISABLE_INDEX          = NO
 146 ENUM_VALUES_PER_LINE   = 4
 147 GENERATE_TREEVIEW      = NO
 148 TREEVIEW_WIDTH         = 250
 149 #---------------------------------------------------------------------------
 150 # configuration options related to the LaTeX output
 151 #---------------------------------------------------------------------------
 152 GENERATE_LATEX         = NO
 153 LATEX_OUTPUT           = latex
 154 LATEX_CMD_NAME         = latex
 155 MAKEINDEX_CMD_NAME     = makeindex
 156 COMPACT_LATEX          = NO
 157 PAPER_TYPE             = a4wide
 158 EXTRA_PACKAGES         =
 159 LATEX_HEADER           =
 160 PDF_HYPERLINKS         = NO
 161 USE_PDFLATEX           = NO
 162 LATEX_BATCHMODE        = NO
 163 LATEX_HIDE_INDICES     = NO
 164 #---------------------------------------------------------------------------
 165 # configuration options related to the RTF output
 166 #---------------------------------------------------------------------------
 167 GENERATE_RTF           = NO
 168 RTF_OUTPUT             = rtf
 169 COMPACT_RTF            = NO
 170 RTF_HYPERLINKS         = NO
 171 RTF_STYLESHEET_FILE    =
 172 RTF_EXTENSIONS_FILE    =
 173 #---------------------------------------------------------------------------
 174 # configuration options related to the man page output
 175 #---------------------------------------------------------------------------
 176 GENERATE_MAN           = YES
 177 MAN_OUTPUT             = .
 178 MAN_EXTENSION          = .3
 179 MAN_LINKS              = NO
 180 #---------------------------------------------------------------------------
 181 # configuration options related to the XML output
 182 #---------------------------------------------------------------------------
 183 GENERATE_XML           = NO
 184 XML_OUTPUT             = xml
 185 XML_SCHEMA             =
 186 XML_DTD                =
 187 XML_PROGRAMLISTING     = YES
 188 #---------------------------------------------------------------------------
 189 # configuration options for the AutoGen Definitions output
 190 #---------------------------------------------------------------------------
 191 GENERATE_AUTOGEN_DEF   = NO
 192 #---------------------------------------------------------------------------
 193 # configuration options related to the Perl module output
 194 #---------------------------------------------------------------------------
 195 GENERATE_PERLMOD       = NO
 196 PERLMOD_LATEX          = NO
 197 PERLMOD_PRETTY         = YES
 198 PERLMOD_MAKEVAR_PREFIX =
 199 #---------------------------------------------------------------------------
 200 # Configuration options related to the preprocessor
 201 #---------------------------------------------------------------------------
 202 ENABLE_PREPROCESSING   = YES
 203 MACRO_EXPANSION        = YES
 204 EXPAND_ONLY_PREDEF     = YES
 205 SEARCH_INCLUDES        = YES
 206 INCLUDE_PATH           = ../..
 207 INCLUDE_FILE_PATTERNS  = *.h
 208 PREDEFINED             = HAVE_CONFIG_H= \
 209                          SYMHIDDEN= \
 210                          SYMEXPORT=
 211 EXPAND_AS_DEFINED      =
 212 SKIP_FUNCTION_MACROS   = YES
 213 #---------------------------------------------------------------------------
 214 # Configuration::additions related to external references
 215 #---------------------------------------------------------------------------
 216 TAGFILES               =
 217 GENERATE_TAGFILE       =
 218 ALLEXTERNALS           = NO
 219 EXTERNAL_GROUPS        = YES
 220 PERL_PATH              = /usr/bin/perl
 221 #---------------------------------------------------------------------------
 222 # Configuration options related to the dot tool
 223 #---------------------------------------------------------------------------
 224 CLASS_DIAGRAMS         = NO
 225 MSCGEN_PATH            =
 226 HIDE_UNDOC_RELATIONS   = YES
 227 HAVE_DOT               = YES
 228 CLASS_GRAPH            = YES
 229 COLLABORATION_GRAPH    = YES
 230 GROUP_GRAPHS           = YES
 231 UML_LOOK               = NO
 232 TEMPLATE_RELATIONS     = NO
 233 INCLUDE_GRAPH          = YES
 234 INCLUDED_BY_GRAPH      = YES
 235 CALL_GRAPH             = NO
 236 CALLER_GRAPH           = NO
 237 GRAPHICAL_HIERARCHY    = YES
 238 DIRECTORY_GRAPH        = YES
 239 DOT_IMAGE_FORMAT       = png
 240 DOT_PATH               =
 241 DOTFILE_DIRS           =
 242 DOT_GRAPH_MAX_NODES    = 50
 243 MAX_DOT_GRAPH_DEPTH    = 3
 244 DOT_TRANSPARENT        = NO
 245 DOT_MULTI_TARGETS      = NO
 246 GENERATE_LEGEND        = YES
 247 DOT_CLEANUP            = YES
 248 #---------------------------------------------------------------------------
 249 # Configuration::additions related to the search engine
 250 #---------------------------------------------------------------------------
 251 SEARCHENGINE           = NO