Doxyfile.in

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