lib/apidoc/Doxyfile.in

   1 # Doxyfile 1.3.6
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "@PACKAGE@ (libvserver)"
   7 PROJECT_NUMBER         = @PACKAGE_VERSION@
   8 OUTPUT_DIRECTORY       =
   9 OUTPUT_LANGUAGE        = English
  10 USE_WINDOWS_ENCODING   = NO
  11 BRIEF_MEMBER_DESC      = YES
  12 REPEAT_BRIEF           = YES
  13 ABBREVIATE_BRIEF       =
  14 ALWAYS_DETAILED_SEC    = NO
  15 INLINE_INHERITED_MEMB  = NO
  16 FULL_PATH_NAMES        = NO
  17 STRIP_FROM_PATH        =
  18 SHORT_NAMES            = NO
  19 JAVADOC_AUTOBRIEF      = NO
  20 MULTILINE_CPP_IS_BRIEF = NO
  21 DETAILS_AT_TOP         = NO
  22 INHERIT_DOCS           = YES
  23 DISTRIBUTE_GROUP_DOC   = NO
  24 TAB_SIZE               = 8
  25 ALIASES                =
  26 OPTIMIZE_OUTPUT_FOR_C  = YES
  27 OPTIMIZE_OUTPUT_JAVA   = NO
  28 SUBGROUPING            = YES
  29 #---------------------------------------------------------------------------
  30 # Build related configuration options
  31 #---------------------------------------------------------------------------
  32 EXTRACT_ALL            = NO
  33 EXTRACT_PRIVATE        = YES
  34 EXTRACT_STATIC         = NO
  35 EXTRACT_LOCAL_CLASSES  = YES
  36 HIDE_UNDOC_MEMBERS     = NO
  37 HIDE_UNDOC_CLASSES     = NO
  38 HIDE_FRIEND_COMPOUNDS  = NO
  39 HIDE_IN_BODY_DOCS      = NO
  40 INTERNAL_DOCS          = NO
  41 CASE_SENSE_NAMES       = YES
  42 HIDE_SCOPE_NAMES       = NO
  43 SHOW_INCLUDE_FILES     = YES
  44 INLINE_INFO            = YES
  45 SORT_MEMBER_DOCS       = YES
  46 SORT_BRIEF_DOCS        = NO
  47 SORT_BY_SCOPE_NAME     = NO
  48 GENERATE_TODOLIST      = YES
  49 GENERATE_TESTLIST      = YES
  50 GENERATE_BUGLIST       = YES
  51 GENERATE_DEPRECATEDLIST= YES
  52 ENABLED_SECTIONS       =
  53 MAX_INITIALIZER_LINES  = 30
  54 SHOW_USED_FILES        = YES
  55 #---------------------------------------------------------------------------
  56 # configuration options related to warning and progress messages
  57 #---------------------------------------------------------------------------
  58 QUIET                  = NO
  59 WARNINGS               = YES
  60 WARN_IF_UNDOCUMENTED   = YES
  61 WARN_IF_DOC_ERROR      = YES
  62 WARN_FORMAT            = "$file:$line: $text"
  63 WARN_LOGFILE           =
  64 #---------------------------------------------------------------------------
  65 # configuration options related to the input files
  66 #---------------------------------------------------------------------------
  67 INPUT                  = @top_srcdir@/lib
  68 FILE_PATTERNS          = vserver.h \
  69                          internal.h
  70 RECURSIVE              = NO
  71 EXCLUDE                =
  72 EXCLUDE_SYMLINKS       = NO
  73 EXCLUDE_PATTERNS       =
  74 EXAMPLE_PATH           = @top_srcdir@/lib/apidoc
  75 EXAMPLE_PATTERNS       =
  76 EXAMPLE_RECURSIVE      = NO
  77 IMAGE_PATH             =
  78 INPUT_FILTER           =
  79 FILTER_SOURCE_FILES    = NO
  80 #---------------------------------------------------------------------------
  81 # configuration options related to source browsing
  82 #---------------------------------------------------------------------------
  83 SOURCE_BROWSER         = YES
  84 INLINE_SOURCES         = NO
  85 STRIP_CODE_COMMENTS    = YES
  86 REFERENCED_BY_RELATION = YES
  87 REFERENCES_RELATION    = YES
  88 VERBATIM_HEADERS       = YES
  89 #---------------------------------------------------------------------------
  90 # configuration options related to the alphabetical class index
  91 #---------------------------------------------------------------------------
  92 ALPHABETICAL_INDEX     = NO
  93 COLS_IN_ALPHA_INDEX    = 5
  94 IGNORE_PREFIX          =
  95 #---------------------------------------------------------------------------
  96 # configuration options related to the HTML output
  97 #---------------------------------------------------------------------------
  98 GENERATE_HTML          = YES
  99 HTML_OUTPUT            = html
 100 HTML_FILE_EXTENSION    = .html
 101 HTML_HEADER            =
 102 HTML_FOOTER            =
 103 HTML_STYLESHEET        =
 104 HTML_ALIGN_MEMBERS     = YES
 105 GENERATE_HTMLHELP      = NO
 106 CHM_FILE               =
 107 HHC_LOCATION           =
 108 GENERATE_CHI           = NO
 109 BINARY_TOC             = NO
 110 TOC_EXPAND             = NO
 111 DISABLE_INDEX          = NO
 112 ENUM_VALUES_PER_LINE   = 4
 113 GENERATE_TREEVIEW      = NO
 114 TREEVIEW_WIDTH         = 250
 115 #---------------------------------------------------------------------------
 116 # configuration options related to the LaTeX output
 117 #---------------------------------------------------------------------------
 118 GENERATE_LATEX         = YES
 119 LATEX_OUTPUT           = latex
 120 LATEX_CMD_NAME         = latex
 121 MAKEINDEX_CMD_NAME     = makeindex
 122 COMPACT_LATEX          = YES
 123 PAPER_TYPE             = a4wide
 124 EXTRA_PACKAGES         =
 125 LATEX_HEADER           =
 126 PDF_HYPERLINKS         = YES
 127 USE_PDFLATEX           = YES
 128 LATEX_BATCHMODE        = YES
 129 LATEX_HIDE_INDICES     = NO
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the RTF output
 132 #---------------------------------------------------------------------------
 133 GENERATE_RTF           = NO
 134 RTF_OUTPUT             = rtf
 135 COMPACT_RTF            = NO
 136 RTF_HYPERLINKS         = NO
 137 RTF_STYLESHEET_FILE    =
 138 RTF_EXTENSIONS_FILE    =
 139 #---------------------------------------------------------------------------
 140 # configuration options related to the man page output
 141 #---------------------------------------------------------------------------
 142 GENERATE_MAN           = YES
 143 MAN_OUTPUT             = man
 144 MAN_EXTENSION          = .3
 145 MAN_LINKS              = YES
 146 #---------------------------------------------------------------------------
 147 # configuration options related to the XML output
 148 #---------------------------------------------------------------------------
 149 GENERATE_XML           = NO
 150 XML_OUTPUT             = xml
 151 XML_SCHEMA             =
 152 XML_DTD                =
 153 XML_PROGRAMLISTING     = YES
 154 #---------------------------------------------------------------------------
 155 # configuration options for the AutoGen Definitions output
 156 #---------------------------------------------------------------------------
 157 GENERATE_AUTOGEN_DEF   = NO
 158 #---------------------------------------------------------------------------
 159 # configuration options related to the Perl module output
 160 #---------------------------------------------------------------------------
 161 GENERATE_PERLMOD       = NO
 162 PERLMOD_LATEX          = NO
 163 PERLMOD_PRETTY         = YES
 164 PERLMOD_MAKEVAR_PREFIX =
 165 #---------------------------------------------------------------------------
 166 # Configuration options related to the preprocessor
 167 #---------------------------------------------------------------------------
 168 ENABLE_PREPROCESSING   = YES
 169 MACRO_EXPANSION        = YES
 170 EXPAND_ONLY_PREDEF     = NO
 171 SEARCH_INCLUDES        = YES
 172 INCLUDE_PATH           =
 173 INCLUDE_FILE_PATTERNS  =
 174 PREDEFINED             = VC_ATTR_UNUSED= \
 175                          VC_ATTR_NONNULL(X)= \
 176                          VC_ATTR_NORETURN= \
 177                          VC_ATTR_ALWAYSINLINE= \
 178                          VC_ATTR_PURE= \
 179                          IS_DOXYGEN=1
 180 EXPAND_AS_DEFINED      =
 181 SKIP_FUNCTION_MACROS   = YES
 182 #---------------------------------------------------------------------------
 183 # Configuration::additions related to external references
 184 #---------------------------------------------------------------------------
 185 TAGFILES               =
 186 GENERATE_TAGFILE       =
 187 ALLEXTERNALS           = NO
 188 EXTERNAL_GROUPS        = YES
 189 PERL_PATH              = /usr/bin/perl
 190 #---------------------------------------------------------------------------
 191 # Configuration options related to the dot tool
 192 #---------------------------------------------------------------------------
 193 CLASS_DIAGRAMS         = YES
 194 HIDE_UNDOC_RELATIONS   = YES
 195 HAVE_DOT               = YES
 196 CLASS_GRAPH            = YES
 197 COLLABORATION_GRAPH    = YES
 198 UML_LOOK               = YES
 199 TEMPLATE_RELATIONS     = NO
 200 INCLUDE_GRAPH          = YES
 201 INCLUDED_BY_GRAPH      = YES
 202 CALL_GRAPH             = YES
 203 GRAPHICAL_HIERARCHY    = YES
 204 DOT_IMAGE_FORMAT       = png
 205 DOT_PATH               =
 206 DOTFILE_DIRS           =
 207 MAX_DOT_GRAPH_WIDTH    = 1024
 208 MAX_DOT_GRAPH_HEIGHT   = 1024
 209 MAX_DOT_GRAPH_DEPTH    = 0
 210 GENERATE_LEGEND        = YES
 211 DOT_CLEANUP            = YES
 212 DOT_TRANSPARENT        = YES
 213 DOT_MULTI_TARGETS      = YES
 214 #---------------------------------------------------------------------------
 215 # Configuration::additions related to the search engine
 216 #---------------------------------------------------------------------------
 217 SEARCHENGINE           = NO