doc/Doxyfile

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