src/pmml/doc/doxygen/Doxyfile_pmml_user.in

   1 # Copyright (C) 2007-2015  CEA/DEN, EDF R&D
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 # Doxyfile 0.1
  21 #---------------------------------------------------------------------------
  22 # General configuration options
  23 #---------------------------------------------------------------------------
  24 #
  25 PROJECT_NAME           = "SALOME PMML Users' Guide"
  26 PROJECT_NUMBER         =
  27 OUTPUT_DIRECTORY       = doc_ref_user
  28 OUTPUT_LANGUAGE        = English
  29 EXTRACT_ALL            = YES
  30 EXTRACT_PRIVATE        = NO
  31 EXTRACT_STATIC         = NO
  32 HIDE_UNDOC_MEMBERS     = YES
  33 HIDE_UNDOC_CLASSES     = YES
  34 BRIEF_MEMBER_DESC      = NO
  35 REPEAT_BRIEF           = YES
  36 ALWAYS_DETAILED_SEC    = NO
  37 FULL_PATH_NAMES        = NO
  38 STRIP_FROM_PATH        =
  39 INTERNAL_DOCS          = NO
  40 STRIP_CODE_COMMENTS    = YES
  41 CASE_SENSE_NAMES       = YES
  42 SHORT_NAMES            = NO
  43 HIDE_SCOPE_NAMES       = NO
  44 VERBATIM_HEADERS       = NO
  45 SHOW_INCLUDE_FILES     = NO
  46 JAVADOC_AUTOBRIEF      = NO
  47 INHERIT_DOCS           = YES
  48 MARKDOWN_SUPPORT       = YES
  49 INLINE_INFO            = NO
  50 SORT_MEMBER_DOCS       = NO
  51 DISTRIBUTE_GROUP_DOC   = NO
  52 TAB_SIZE               = 8
  53 GENERATE_TODOLIST      = YES
  54 GENERATE_TESTLIST      = YES
  55 GENERATE_BUGLIST       = YES
  56 ALIASES                =
  57 ENABLED_SECTIONS       = user PMML_ug
  58 MAX_INITIALIZER_LINES  = 30
  59 OPTIMIZE_OUTPUT_FOR_C  = NO
  60 SHOW_USED_FILES        = NO
  61 #---------------------------------------------------------------------------
  62 # configuration options related to warning and progress messages
  63 #---------------------------------------------------------------------------
  64 QUIET                  = NO
  65 WARNINGS               = YES
  66 WARN_IF_UNDOCUMENTED   = YES
  67 WARN_FORMAT            = "$file:$line: $text"
  68 WARN_LOGFILE           = log_user
  69 #---------------------------------------------------------------------------
  70 # configuration options related to the input files
  71 #---------------------------------------------------------------------------
  72
  73 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/intro.dox \
  74                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/cppexamples.dox \
  75                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/pyexamples.dox \
  76                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/pmml.dox \
  77                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/install.dox \
  78                          @CMAKE_SOURCE_DIR@/src/pmml
  79
  80 FILE_PATTERNS          = PMMLlib.* \
  81                          *.dox
  82 RECURSIVE              = YES
  83 EXCLUDE                = CVS
  84 EXCLUDE_PATTERNS       = *~
  85 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@/src/pmml \
  86                          @CMAKE_SOURCE_DIR@/src/pmml/Test \
  87                          @CMAKE_SOURCE_DIR@/src/pmml/pmml_Swig
  88
  89 EXAMPLE_PATTERNS       = *.cxx *.py
  90 EXAMPLE_RECURSIVE      = NO
  91 IMAGE_PATH             =
  92 INPUT_FILTER           =
  93 FILTER_SOURCE_FILES    = NO
  94 #---------------------------------------------------------------------------
  95 # configuration options related to source browsing
  96 #---------------------------------------------------------------------------
  97 SOURCE_BROWSER         = NO
  98 INLINE_SOURCES         = NO
  99 REFERENCED_BY_RELATION = YES
 100 REFERENCES_RELATION    = YES
 101 #---------------------------------------------------------------------------
 102 # configuration options related to the alphabetical class index
 103 #---------------------------------------------------------------------------
 104 ALPHABETICAL_INDEX     = YES
 105 COLS_IN_ALPHA_INDEX    = 5
 106 IGNORE_PREFIX          =
 107 #---------------------------------------------------------------------------
 108 # configuration options related to the HTML output
 109 #---------------------------------------------------------------------------
 110 GENERATE_HTML          = YES
 111 HTML_OUTPUT            = html
 112 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 113 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 114 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
 115 GENERATE_HTMLHELP      = NO
 116 GENERATE_CHI           = YES
 117 BINARY_TOC             = NO
 118 TOC_EXPAND             = YES
 119 DISABLE_INDEX          = NO
 120 ENUM_VALUES_PER_LINE   = 4
 121 GENERATE_TREEVIEW      = YES
 122 TREEVIEW_WIDTH         = 250
 123
 124 #---------------------------------------------------------------------------
 125 #SORT related options
 126 #---------------------------------------------------------------------------
 127 SORT_GROUP_NAMES = NO
 128
 129 #---------------------------------------------------------------------------
 130 # configuration options related to the LaTeX output
 131 #---------------------------------------------------------------------------
 132 GENERATE_LATEX         = YES
 133 LATEX_OUTPUT           = latex
 134 COMPACT_LATEX          = YES
 135 PAPER_TYPE             = a4wide
 136 EXTRA_PACKAGES         =
 137 LATEX_HEADER           =
 138 PDF_HYPERLINKS         = NO
 139 USE_PDFLATEX           = NO
 140 LATEX_BATCHMODE        = NO
 141 #---------------------------------------------------------------------------
 142 # configuration options related to the RTF output
 143 #---------------------------------------------------------------------------
 144 GENERATE_RTF           = NO
 145 RTF_OUTPUT             = rtf
 146 COMPACT_RTF            = NO
 147 RTF_HYPERLINKS         = NO
 148 RTF_STYLESHEET_FILE    =
 149 RTF_EXTENSIONS_FILE    =
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the man page output
 152 #---------------------------------------------------------------------------
 153 GENERATE_MAN           = NO
 154 MAN_OUTPUT             = man
 155 MAN_EXTENSION          = .3
 156 MAN_LINKS              = NO
 157 #---------------------------------------------------------------------------
 158 # configuration options related to the XML output
 159 #---------------------------------------------------------------------------
 160 GENERATE_XML           = NO
 161 #---------------------------------------------------------------------------
 162 # Configuration options related to the preprocessor
 163 #---------------------------------------------------------------------------
 164 ENABLE_PREPROCESSING   = YES
 165 MACRO_EXPANSION        = YES
 166 EXPAND_ONLY_PREDEF     = YES
 167 SEARCH_INCLUDES        = YES
 168 INCLUDE_PATH           =
 169 INCLUDE_FILE_PATTERNS  =
 170 PREDEFINED             =
 171 EXPAND_AS_DEFINED      = PMMLLIB_EXPORT
 172 SKIP_FUNCTION_MACROS   = YES
 173 #---------------------------------------------------------------------------
 174 # Configuration::addtions related to external references
 175 #---------------------------------------------------------------------------
 176 TAGFILES               =
 177 GENERATE_TAGFILE       =
 178 ALLEXTERNALS           = NO
 179 PERL_PATH              = /usr/bin/perl
 180 #---------------------------------------------------------------------------
 181 # Configuration options related to the dot tool
 182 #---------------------------------------------------------------------------
 183 CLASS_DIAGRAMS         = YES
 184 HAVE_DOT               = YES
 185 CLASS_GRAPH            = YES
 186 COLLABORATION_GRAPH    = YES
 187 TEMPLATE_RELATIONS     = YES
 188 HIDE_UNDOC_RELATIONS   = YES
 189 INCLUDE_GRAPH          = YES
 190 INCLUDED_BY_GRAPH      = YES
 191 GRAPHICAL_HIERARCHY    = YES
 192 DOT_PATH               =
 193 DOT_FONTNAME           = Arial
 194 DOTFILE_DIRS           =
 195 GENERATE_LEGEND        = YES
 196 DOT_CLEANUP            = YES
 197 #---------------------------------------------------------------------------
 198 # Configuration::addtions related to the search engine
 199 #---------------------------------------------------------------------------
 200 SEARCHENGINE           = NO