doxygen.cfg

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