src/pmml/doc/doxygen/Doxyfile_pmml_user.in

   1 # Doxyfile 0.1
   2 #---------------------------------------------------------------------------
   3 # General configuration options
   4 #---------------------------------------------------------------------------
   5 #
   6 PROJECT_NAME           = "SALOME PMML Users' Guide"
   7 PROJECT_NUMBER         =
   8 OUTPUT_DIRECTORY       = doc_ref_user
   9 OUTPUT_LANGUAGE        = English
  10 EXTRACT_ALL            = YES
  11 EXTRACT_PRIVATE        = NO
  12 EXTRACT_STATIC         = NO
  13 HIDE_UNDOC_MEMBERS     = YES
  14 HIDE_UNDOC_CLASSES     = YES
  15 BRIEF_MEMBER_DESC      = NO
  16 REPEAT_BRIEF           = YES
  17 ALWAYS_DETAILED_SEC    = NO
  18 FULL_PATH_NAMES        = NO
  19 STRIP_FROM_PATH        =
  20 INTERNAL_DOCS          = NO
  21 STRIP_CODE_COMMENTS    = YES
  22 CASE_SENSE_NAMES       = YES
  23 SHORT_NAMES            = NO
  24 HIDE_SCOPE_NAMES       = NO
  25 VERBATIM_HEADERS       = NO
  26 SHOW_INCLUDE_FILES     = NO
  27 JAVADOC_AUTOBRIEF      = NO
  28 INHERIT_DOCS           = YES
  29 MARKDOWN_SUPPORT       = YES
  30 INLINE_INFO            = NO
  31 SORT_MEMBER_DOCS       = NO
  32 DISTRIBUTE_GROUP_DOC   = NO
  33 TAB_SIZE               = 8
  34 GENERATE_TODOLIST      = YES
  35 GENERATE_TESTLIST      = YES
  36 GENERATE_BUGLIST       = YES
  37 ALIASES                =
  38 ENABLED_SECTIONS       = user PMML_ug
  39 MAX_INITIALIZER_LINES  = 30
  40 OPTIMIZE_OUTPUT_FOR_C  = NO
  41 SHOW_USED_FILES        = NO
  42 #---------------------------------------------------------------------------
  43 # configuration options related to warning and progress messages
  44 #---------------------------------------------------------------------------
  45 QUIET                  = NO
  46 WARNINGS               = YES
  47 WARN_IF_UNDOCUMENTED   = YES
  48 WARN_FORMAT            = "$file:$line: $text"
  49 WARN_LOGFILE           = log_user
  50 #---------------------------------------------------------------------------
  51 # configuration options related to the input files
  52 #---------------------------------------------------------------------------
  53
  54 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/intro.dox \
  55                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/cppexamples.dox \
  56                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/pyexamples.dox \
  57                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/pmml.dox \
  58                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/install.dox \
  59                          @CMAKE_SOURCE_DIR@/src/pmml
  60
  61 FILE_PATTERNS          = PMMLlib.* \
  62                          *.dox
  63 RECURSIVE              = YES
  64 EXCLUDE                = CVS
  65 EXCLUDE_PATTERNS       = *~
  66 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@/src/pmml \
  67                          @CMAKE_SOURCE_DIR@/src/pmml/Test \
  68                          @CMAKE_SOURCE_DIR@/src/pmml/pmml_Swig
  69
  70 EXAMPLE_PATTERNS       = *.cxx *.py
  71 EXAMPLE_RECURSIVE      = NO
  72 IMAGE_PATH             =
  73 INPUT_FILTER           =
  74 FILTER_SOURCE_FILES    = NO
  75 #---------------------------------------------------------------------------
  76 # configuration options related to source browsing
  77 #---------------------------------------------------------------------------
  78 SOURCE_BROWSER         = NO
  79 INLINE_SOURCES         = NO
  80 REFERENCED_BY_RELATION = YES
  81 REFERENCES_RELATION    = YES
  82 #---------------------------------------------------------------------------
  83 # configuration options related to the alphabetical class index
  84 #---------------------------------------------------------------------------
  85 ALPHABETICAL_INDEX     = YES
  86 COLS_IN_ALPHA_INDEX    = 5
  87 IGNORE_PREFIX          =
  88 #---------------------------------------------------------------------------
  89 # configuration options related to the HTML output
  90 #---------------------------------------------------------------------------
  91 GENERATE_HTML          = YES
  92 HTML_OUTPUT            = html
  93 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
  94 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
  95 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
  96 HTML_EXTRA_FILES       = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png
  97 GENERATE_HTMLHELP      = NO
  98 GENERATE_CHI           = YES
  99 BINARY_TOC             = NO
 100 TOC_EXPAND             = YES
 101 DISABLE_INDEX          = NO
 102 ENUM_VALUES_PER_LINE   = 4
 103 GENERATE_TREEVIEW      = YES
 104 TREEVIEW_WIDTH         = 250
 105
 106 #---------------------------------------------------------------------------
 107 #SORT related options
 108 #---------------------------------------------------------------------------
 109 SORT_GROUP_NAMES = NO
 110
 111 #---------------------------------------------------------------------------
 112 # configuration options related to the LaTeX output
 113 #---------------------------------------------------------------------------
 114 GENERATE_LATEX         = YES
 115 LATEX_OUTPUT           = latex
 116 COMPACT_LATEX          = YES
 117 PAPER_TYPE             = a4wide
 118 EXTRA_PACKAGES         =
 119 LATEX_HEADER           =
 120 PDF_HYPERLINKS         = NO
 121 USE_PDFLATEX           = NO
 122 LATEX_BATCHMODE        = NO
 123 #---------------------------------------------------------------------------
 124 # configuration options related to the RTF output
 125 #---------------------------------------------------------------------------
 126 GENERATE_RTF           = NO
 127 RTF_OUTPUT             = rtf
 128 COMPACT_RTF            = NO
 129 RTF_HYPERLINKS         = NO
 130 RTF_STYLESHEET_FILE    =
 131 RTF_EXTENSIONS_FILE    =
 132 #---------------------------------------------------------------------------
 133 # configuration options related to the man page output
 134 #---------------------------------------------------------------------------
 135 GENERATE_MAN           = NO
 136 MAN_OUTPUT             = man
 137 MAN_EXTENSION          = .3
 138 MAN_LINKS              = NO
 139 #---------------------------------------------------------------------------
 140 # configuration options related to the XML output
 141 #---------------------------------------------------------------------------
 142 GENERATE_XML           = NO
 143 #---------------------------------------------------------------------------
 144 # Configuration options related to the preprocessor
 145 #---------------------------------------------------------------------------
 146 ENABLE_PREPROCESSING   = YES
 147 MACRO_EXPANSION        = YES
 148 EXPAND_ONLY_PREDEF     = YES
 149 SEARCH_INCLUDES        = YES
 150 INCLUDE_PATH           =
 151 INCLUDE_FILE_PATTERNS  =
 152 PREDEFINED             =
 153 EXPAND_AS_DEFINED      = PMMLLIB_EXPORT
 154 SKIP_FUNCTION_MACROS   = YES
 155 #---------------------------------------------------------------------------
 156 # Configuration::addtions related to external references
 157 #---------------------------------------------------------------------------
 158 TAGFILES               =
 159 GENERATE_TAGFILE       =
 160 ALLEXTERNALS           = NO
 161 PERL_PATH              = /usr/bin/perl
 162 #---------------------------------------------------------------------------
 163 # Configuration options related to the dot tool
 164 #---------------------------------------------------------------------------
 165 CLASS_DIAGRAMS         = YES
 166 HAVE_DOT               = YES
 167 CLASS_GRAPH            = YES
 168 COLLABORATION_GRAPH    = YES
 169 TEMPLATE_RELATIONS     = YES
 170 HIDE_UNDOC_RELATIONS   = YES
 171 INCLUDE_GRAPH          = YES
 172 INCLUDED_BY_GRAPH      = YES
 173 GRAPHICAL_HIERARCHY    = YES
 174 DOT_PATH               =
 175 DOT_FONTNAME           = Arial
 176 DOTFILE_DIRS           =
 177 GENERATE_LEGEND        = YES
 178 DOT_CLEANUP            = YES
 179 #---------------------------------------------------------------------------
 180 # Configuration::addtions related to the search engine
 181 #---------------------------------------------------------------------------
 182 SEARCHENGINE           = NO