src/MEDMEM/Doxyfile_med_user.in

   1 # Copyright (C) 2007-2013  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
  23 # Doxyfile 0.1
  24 #---------------------------------------------------------------------------
  25 # General configuration options
  26 #---------------------------------------------------------------------------
  27 #
  28 PROJECT_NAME           = "Med Memory Users'"
  29 PROJECT_NUMBER         = @VERSION@
  30 OUTPUT_DIRECTORY       = doc_ref_user
  31 OUTPUT_LANGUAGE        = English
  32 EXTRACT_ALL            = YES
  33 EXTRACT_PRIVATE        = NO
  34 EXTRACT_STATIC         = NO
  35 HIDE_UNDOC_MEMBERS     = YES
  36 HIDE_UNDOC_CLASSES     = YES
  37 BRIEF_MEMBER_DESC      = NO
  38 REPEAT_BRIEF           = YES
  39 ALWAYS_DETAILED_SEC    = NO
  40 FULL_PATH_NAMES        = NO
  41 STRIP_FROM_PATH        =
  42 INTERNAL_DOCS          = NO
  43 STRIP_CODE_COMMENTS    = YES
  44 CASE_SENSE_NAMES       = YES
  45 SHORT_NAMES            = NO
  46 HIDE_SCOPE_NAMES       = NO
  47 VERBATIM_HEADERS       = NO
  48 SHOW_INCLUDE_FILES     = NO
  49 JAVADOC_AUTOBRIEF      = NO
  50 INHERIT_DOCS           = YES
  51 INLINE_INFO            = NO
  52 SORT_MEMBER_DOCS       = NO
  53 DISTRIBUTE_GROUP_DOC   = NO
  54 TAB_SIZE               = 8
  55 GENERATE_TODOLIST      = YES
  56 GENERATE_TESTLIST      = YES
  57 GENERATE_BUGLIST       = YES
  58 ALIASES                =
  59 ENABLED_SECTIONS       =
  60 MAX_INITIALIZER_LINES  = 30
  61 OPTIMIZE_OUTPUT_FOR_C  = NO
  62 SHOW_USED_FILES        = NO
  63 #---------------------------------------------------------------------------
  64 # configuration options related to warning and progress messages
  65 #---------------------------------------------------------------------------
  66 QUIET                  = NO
  67 WARNINGS               = YES
  68 WARN_IF_UNDOCUMENTED   = YES
  69 WARN_FORMAT            = "$file:$line: $text"
  70 WARN_LOGFILE           = log_user
  71 #---------------------------------------------------------------------------
  72 # configuration options related to the input files
  73 #---------------------------------------------------------------------------
  74 INPUT                  = @srcdir@
  75 FILE_PATTERNS          = MEDMEM*.hxx \
  76                          MEDMEM*.cxx
  77 RECURSIVE              = NO
  78 EXCLUDE                = CVS
  79 EXCLUDE_PATTERNS       = MEDMEM_DriversDef.* \
  80                          MEDMEM_DriverTools.* \
  81                          MEDMEM_SkyLineArray.* \
  82                          MEDMEM_TypeMeshDriver.* \
  83                          MEDMEM_CellModel.* \
  84                          MEDMEM_Exception.* \
  85                          MEDMEM_GenDriver.* \
  86                          MEDMEM_Array.hxx \
  87                          MEDMEM_PointerOf.hxx \
  88                          MEDMEM_STRING.hxx \
  89                          MEDMEM_Utilities.hxx \
  90                          MEDMEM_Connectivity.cxx \
  91                          MEDMEM_Connectivity.hxx \
  92                          MEDMEM_Coordinate.cxx \
  93                          MEDMEM_Coordinate.hxx \
  94                          MEDMEM_ModulusArray.hxx
  95 EXAMPLE_PATH           =
  96 EXAMPLE_PATTERNS       =
  97 EXAMPLE_RECURSIVE      = NO
  98 IMAGE_PATH             =
  99 INPUT_FILTER           =
 100 FILTER_SOURCE_FILES    = NO
 101 #---------------------------------------------------------------------------
 102 # configuration options related to source browsing
 103 #---------------------------------------------------------------------------
 104 SOURCE_BROWSER         = NO
 105 INLINE_SOURCES         = NO
 106 REFERENCED_BY_RELATION = YES
 107 REFERENCES_RELATION    = YES
 108 #---------------------------------------------------------------------------
 109 # configuration options related to the alphabetical class index
 110 #---------------------------------------------------------------------------
 111 ALPHABETICAL_INDEX     = YES
 112 COLS_IN_ALPHA_INDEX    = 5
 113 IGNORE_PREFIX          =
 114 #---------------------------------------------------------------------------
 115 # configuration options related to the HTML output
 116 #---------------------------------------------------------------------------
 117 GENERATE_HTML          = YES
 118 HTML_OUTPUT            = html
 119 HTML_HEADER            =
 120 HTML_FOOTER            =
 121 HTML_STYLESHEET        =
 122 HTML_ALIGN_MEMBERS     = YES
 123 GENERATE_HTMLHELP      = YES
 124 GENERATE_CHI           = YES
 125 BINARY_TOC             = NO
 126 TOC_EXPAND             = YES
 127 DISABLE_INDEX          = NO
 128 ENUM_VALUES_PER_LINE   = 4
 129 GENERATE_TREEVIEW      = YES
 130 TREEVIEW_WIDTH         = 250
 131 #---------------------------------------------------------------------------
 132 # configuration options related to the LaTeX output
 133 #---------------------------------------------------------------------------
 134 GENERATE_LATEX         = YES
 135 LATEX_OUTPUT           = latex
 136 COMPACT_LATEX          = NO
 137 PAPER_TYPE             = a4wide
 138 EXTRA_PACKAGES         =
 139 LATEX_HEADER           =
 140 PDF_HYPERLINKS         = NO
 141 USE_PDFLATEX           = NO
 142 LATEX_BATCHMODE        = NO
 143 #---------------------------------------------------------------------------
 144 # configuration options related to the RTF output
 145 #---------------------------------------------------------------------------
 146 GENERATE_RTF           = NO
 147 RTF_OUTPUT             = rtf
 148 COMPACT_RTF            = NO
 149 RTF_HYPERLINKS         = NO
 150 RTF_STYLESHEET_FILE    =
 151 RTF_EXTENSIONS_FILE    =
 152 #---------------------------------------------------------------------------
 153 # configuration options related to the man page output
 154 #---------------------------------------------------------------------------
 155 GENERATE_MAN           = NO
 156 MAN_OUTPUT             = man
 157 MAN_EXTENSION          = .3
 158 MAN_LINKS              = NO
 159 #---------------------------------------------------------------------------
 160 # configuration options related to the XML output
 161 #---------------------------------------------------------------------------
 162 GENERATE_XML           = NO
 163 #---------------------------------------------------------------------------
 164 # Configuration options related to the preprocessor
 165 #---------------------------------------------------------------------------
 166 ENABLE_PREPROCESSING   = YES
 167 MACRO_EXPANSION        = NO
 168 EXPAND_ONLY_PREDEF     = NO
 169 SEARCH_INCLUDES        = YES
 170 INCLUDE_PATH           =
 171 INCLUDE_FILE_PATTERNS  =
 172 PREDEFINED             =
 173 EXPAND_AS_DEFINED      =
 174 SKIP_FUNCTION_MACROS   = YES
 175 #---------------------------------------------------------------------------
 176 # Configuration::addtions related to external references
 177 #---------------------------------------------------------------------------
 178 TAGFILES               =
 179 GENERATE_TAGFILE       =
 180 ALLEXTERNALS           = NO
 181 PERL_PATH              = /usr/bin/perl
 182 #---------------------------------------------------------------------------
 183 # Configuration options related to the dot tool
 184 #---------------------------------------------------------------------------
 185 CLASS_DIAGRAMS         = YES
 186 HAVE_DOT               = YES
 187 CLASS_GRAPH            = YES
 188 COLLABORATION_GRAPH    = YES
 189 TEMPLATE_RELATIONS     = YES
 190 HIDE_UNDOC_RELATIONS   = YES
 191 INCLUDE_GRAPH          = YES
 192 INCLUDED_BY_GRAPH      = YES
 193 GRAPHICAL_HIERARCHY    = YES
 194 DOT_FONTNAME           = Arial
 195 DOT_PATH               =
 196 DOTFILE_DIRS           =
 197 MAX_DOT_GRAPH_WIDTH    = 1024
 198 MAX_DOT_GRAPH_HEIGHT   = 1024
 199 GENERATE_LEGEND        = YES
 200 DOT_CLEANUP            = YES
 201 #---------------------------------------------------------------------------
 202 # Configuration::addtions related to the search engine
 203 #---------------------------------------------------------------------------
 204 SEARCHENGINE           = NO
 205 CGI_NAME               = search.cgi
 206 CGI_URL                =
 207 DOC_URL                =
 208 DOC_ABSPATH            =
 209 BIN_ABSPATH            = /usr/local/bin/
 210 EXT_DOC_PATHS          =