doc/doxygen/Doxyfile_med_user.in

   1 #  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 #  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 #  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 #
   6 #  This library is free software; you can redistribute it and/or
   7 #  modify it under the terms of the GNU Lesser General Public
   8 #  License as published by the Free Software Foundation; either
   9 #  version 2.1 of the License.
  10 #
  11 #  This library is distributed in the hope that it will be useful,
  12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 #  Lesser General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU Lesser General Public
  17 #  License along with this library; if not, write to the Free Software
  18 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 #
  20 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 #
  22 # Doxyfile 0.1
  23 #---------------------------------------------------------------------------
  24 # General configuration options
  25 #---------------------------------------------------------------------------
  26 #
  27 PROJECT_NAME           = "Med Memory Users' Guide"
  28 PROJECT_NUMBER         = @VERSION@
  29 OUTPUT_DIRECTORY       = doc_ref_user
  30 OUTPUT_LANGUAGE        = English
  31 EXTRACT_ALL            = YES
  32 EXTRACT_PRIVATE        = NO
  33 EXTRACT_STATIC         = NO
  34 HIDE_UNDOC_MEMBERS     = YES
  35 HIDE_UNDOC_CLASSES     = YES
  36 BRIEF_MEMBER_DESC      = NO
  37 REPEAT_BRIEF           = YES
  38 ALWAYS_DETAILED_SEC    = NO
  39 FULL_PATH_NAMES        = NO
  40 STRIP_FROM_PATH        =
  41 INTERNAL_DOCS          = NO
  42 STRIP_CODE_COMMENTS    = YES
  43 CASE_SENSE_NAMES       = YES
  44 SHORT_NAMES            = NO
  45 HIDE_SCOPE_NAMES       = NO
  46 VERBATIM_HEADERS       = NO
  47 SHOW_INCLUDE_FILES     = NO
  48 JAVADOC_AUTOBRIEF      = NO
  49 INHERIT_DOCS           = YES
  50 INLINE_INFO            = NO
  51 SORT_MEMBER_DOCS       = NO
  52 DISTRIBUTE_GROUP_DOC   = NO
  53 TAB_SIZE               = 8
  54 GENERATE_TODOLIST      = YES
  55 GENERATE_TESTLIST      = YES
  56 GENERATE_BUGLIST       = YES
  57 ALIASES                =
  58 ENABLED_SECTIONS       = user MEDMEM_ug
  59 MAX_INITIALIZER_LINES  = 30
  60 OPTIMIZE_OUTPUT_FOR_C  = NO
  61 SHOW_USED_FILES        = NO
  62 #---------------------------------------------------------------------------
  63 # configuration options related to warning and progress messages
  64 #---------------------------------------------------------------------------
  65 QUIET                  = NO
  66 WARNINGS               = YES
  67 WARN_IF_UNDOCUMENTED   = YES
  68 WARN_FORMAT            = "$file:$line: $text"
  69 WARN_LOGFILE           = log_user
  70 #---------------------------------------------------------------------------
  71 # configuration options related to the input files
  72 #---------------------------------------------------------------------------
  73 INPUT                  = @srcdir@ \
  74                          @srcdir@/../../src/ParaMEDMEM \
  75                          @srcdir@/../../src/INTERP_KERNEL \
  76                          @srcdir@/../../src/INTERP_KERNEL/Geometric2D \
  77                          @srcdir@/../../src/MEDMEM
  78
  79 FILE_PATTERNS          = MEDMEM_Mesh.* \
  80                          MEDMEM_Grid.* \
  81                          MEDMEM_Meshing.* \
  82                          MEDMEM_Support.* \
  83                          MEDMEM_Field.* \
  84                          MEDMEM_Med.* \
  85                          IntersectionDEC.* \
  86                          DEC.* \
  87                          MPIProcessorGroup.* \
  88                          StructuredCoincidentDEC.* \
  89                          ExplicitCoincidentDEC.* \
  90                          NonCoincidentDEC.* \
  91                          CommInterface.* \
  92                          Interpolation2D.* \
  93                          Interpolation3D.* \
  94                          Interpolation3DSurf.* \
  95                          InterpolationMatrix.* \
  96                          PlanarIntersector.* \
  97                          TargetIntersector.* \
  98                          Interpolation.* \
  99                          AbstractEdge.* \
 100                          Edge.* \
 101                          EdgeArcCircle.* \
 102                          EdgeLin.* \
 103                          ComposedEdge.* \
 104                          ElementaryEdge.* \
 105                          Node.* \
 106                          QuadraticPolygon.* \
 107                          ParaFIELD.* \
 108                          *.dox
 109 RECURSIVE              = NO
 110 EXCLUDE                = CVS
 111 EXCLUDE_PATTERNS       = *~
 112 EXAMPLE_PATH           = @srcdir@/../../src/ParaMEDMEM/ \
 113                          @srcdir@/../../doc/MEDMEM \
 114                          @srcdir@/../../src/MEDMEM
 115 EXAMPLE_PATTERNS       = *.cxx *.py
 116 EXAMPLE_RECURSIVE      = NO
 117 IMAGE_PATH             = @srcdir@/figures
 118 INPUT_FILTER           =
 119 FILTER_SOURCE_FILES    = NO
 120 #---------------------------------------------------------------------------
 121 # configuration options related to source browsing
 122 #---------------------------------------------------------------------------
 123 SOURCE_BROWSER         = NO
 124 INLINE_SOURCES         = NO
 125 REFERENCED_BY_RELATION = YES
 126 REFERENCES_RELATION    = YES
 127 #---------------------------------------------------------------------------
 128 # configuration options related to the alphabetical class index
 129 #---------------------------------------------------------------------------
 130 ALPHABETICAL_INDEX     = YES
 131 COLS_IN_ALPHA_INDEX    = 5
 132 IGNORE_PREFIX          =
 133 #---------------------------------------------------------------------------
 134 # configuration options related to the HTML output
 135 #---------------------------------------------------------------------------
 136 GENERATE_HTML          = YES
 137 HTML_OUTPUT            = html
 138 HTML_HEADER            =
 139 HTML_FOOTER            =
 140 HTML_STYLESHEET        =
 141 HTML_ALIGN_MEMBERS     = YES
 142 GENERATE_HTMLHELP      = YES
 143 GENERATE_CHI           = YES
 144 BINARY_TOC             = NO
 145 TOC_EXPAND             = YES
 146 DISABLE_INDEX          = NO
 147 ENUM_VALUES_PER_LINE   = 4
 148 GENERATE_TREEVIEW      = YES
 149 TREEVIEW_WIDTH         = 250
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the LaTeX output
 152 #---------------------------------------------------------------------------
 153 GENERATE_LATEX         = YES
 154 LATEX_OUTPUT           = latex
 155 COMPACT_LATEX          = YES
 156 PAPER_TYPE             = a4wide
 157 EXTRA_PACKAGES         =
 158 LATEX_HEADER           =
 159 PDF_HYPERLINKS         = NO
 160 USE_PDFLATEX           = NO
 161 LATEX_BATCHMODE        = NO
 162 #---------------------------------------------------------------------------
 163 # configuration options related to the RTF output
 164 #---------------------------------------------------------------------------
 165 GENERATE_RTF           = NO
 166 RTF_OUTPUT             = rtf
 167 COMPACT_RTF            = NO
 168 RTF_HYPERLINKS         = NO
 169 RTF_STYLESHEET_FILE    =
 170 RTF_EXTENSIONS_FILE    =
 171 #---------------------------------------------------------------------------
 172 # configuration options related to the man page output
 173 #---------------------------------------------------------------------------
 174 GENERATE_MAN           = NO
 175 MAN_OUTPUT             = man
 176 MAN_EXTENSION          = .3
 177 MAN_LINKS              = NO
 178 #---------------------------------------------------------------------------
 179 # configuration options related to the XML output
 180 #---------------------------------------------------------------------------
 181 GENERATE_XML           = NO
 182 #---------------------------------------------------------------------------
 183 # Configuration options related to the preprocessor
 184 #---------------------------------------------------------------------------
 185 ENABLE_PREPROCESSING   = YES
 186 MACRO_EXPANSION        = NO
 187 EXPAND_ONLY_PREDEF     = NO
 188 SEARCH_INCLUDES        = YES
 189 INCLUDE_PATH           =
 190 INCLUDE_FILE_PATTERNS  =
 191 PREDEFINED             =
 192 EXPAND_AS_DEFINED      =
 193 SKIP_FUNCTION_MACROS   = YES
 194 #---------------------------------------------------------------------------
 195 # Configuration::addtions related to external references
 196 #---------------------------------------------------------------------------
 197 TAGFILES               =
 198 GENERATE_TAGFILE       =
 199 ALLEXTERNALS           = NO
 200 PERL_PATH              = /usr/bin/perl
 201 #---------------------------------------------------------------------------
 202 # Configuration options related to the dot tool
 203 #---------------------------------------------------------------------------
 204 CLASS_DIAGRAMS         = YES
 205 HAVE_DOT               = YES
 206 CLASS_GRAPH            = YES
 207 COLLABORATION_GRAPH    = YES
 208 TEMPLATE_RELATIONS     = YES
 209 HIDE_UNDOC_RELATIONS   = YES
 210 INCLUDE_GRAPH          = YES
 211 INCLUDED_BY_GRAPH      = YES
 212 GRAPHICAL_HIERARCHY    = YES
 213 DOT_PATH               =
 214 DOTFILE_DIRS           =
 215 MAX_DOT_GRAPH_WIDTH    = 1024
 216 MAX_DOT_GRAPH_HEIGHT   = 1024
 217 GENERATE_LEGEND        = YES
 218 DOT_CLEANUP            = YES
 219 #---------------------------------------------------------------------------
 220 # Configuration::addtions related to the search engine
 221 #---------------------------------------------------------------------------
 222 SEARCHENGINE           = NO
 223 CGI_NAME               = search.cgi
 224 CGI_URL                =
 225 DOC_URL                =
 226 DOC_ABSPATH            =
 227 BIN_ABSPATH            = /usr/local/bin/
 228 EXT_DOC_PATHS          =