src/MEDMEM/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'"
  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       =
  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 FILE_PATTERNS          = MEDMEM*.hxx \
  75                          MEDMEM*.cxx
  76 RECURSIVE              = NO
  77 EXCLUDE                = CVS
  78 EXCLUDE_PATTERNS       = MEDMEM_DriversDef.* \
  79                          MEDMEM_DriverTools.* \
  80                          MEDMEM_SkyLineArray.* \
  81                          MEDMEM_TypeMeshDriver.* \
  82                          MEDMEM_CellModel.* \
  83                          MEDMEM_Exception.* \
  84                          MEDMEM_GenDriver.* \
  85                          MEDMEM_Array.hxx \
  86                          MEDMEM_PointerOf.hxx \
  87                          MEDMEM_STRING.hxx \
  88                          MEDMEM_Utilities.hxx \
  89                          MEDMEM_Connectivity.cxx \
  90                          MEDMEM_Connectivity.hxx \
  91                          MEDMEM_Coordinate.cxx \
  92                          MEDMEM_Coordinate.hxx \
  93                          MEDMEM_ModulusArray.hxx
  94 EXAMPLE_PATH           =
  95 EXAMPLE_PATTERNS       =
  96 EXAMPLE_RECURSIVE      = NO
  97 IMAGE_PATH             =
  98 INPUT_FILTER           =
  99 FILTER_SOURCE_FILES    = NO
 100 #---------------------------------------------------------------------------
 101 # configuration options related to source browsing
 102 #---------------------------------------------------------------------------
 103 SOURCE_BROWSER         = NO
 104 INLINE_SOURCES         = NO
 105 REFERENCED_BY_RELATION = YES
 106 REFERENCES_RELATION    = YES
 107 #---------------------------------------------------------------------------
 108 # configuration options related to the alphabetical class index
 109 #---------------------------------------------------------------------------
 110 ALPHABETICAL_INDEX     = YES
 111 COLS_IN_ALPHA_INDEX    = 5
 112 IGNORE_PREFIX          =
 113 #---------------------------------------------------------------------------
 114 # configuration options related to the HTML output
 115 #---------------------------------------------------------------------------
 116 GENERATE_HTML          = YES
 117 HTML_OUTPUT            = html
 118 HTML_HEADER            =
 119 HTML_FOOTER            =
 120 HTML_STYLESHEET        =
 121 HTML_ALIGN_MEMBERS     = YES
 122 GENERATE_HTMLHELP      = YES
 123 GENERATE_CHI           = YES
 124 BINARY_TOC             = NO
 125 TOC_EXPAND             = YES
 126 DISABLE_INDEX          = NO
 127 ENUM_VALUES_PER_LINE   = 4
 128 GENERATE_TREEVIEW      = YES
 129 TREEVIEW_WIDTH         = 250
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the LaTeX output
 132 #---------------------------------------------------------------------------
 133 GENERATE_LATEX         = YES
 134 LATEX_OUTPUT           = latex
 135 COMPACT_LATEX          = NO
 136 PAPER_TYPE             = a4wide
 137 EXTRA_PACKAGES         =
 138 LATEX_HEADER           =
 139 PDF_HYPERLINKS         = NO
 140 USE_PDFLATEX           = NO
 141 LATEX_BATCHMODE        = NO
 142 #---------------------------------------------------------------------------
 143 # configuration options related to the RTF output
 144 #---------------------------------------------------------------------------
 145 GENERATE_RTF           = NO
 146 RTF_OUTPUT             = rtf
 147 COMPACT_RTF            = NO
 148 RTF_HYPERLINKS         = NO
 149 RTF_STYLESHEET_FILE    =
 150 RTF_EXTENSIONS_FILE    =
 151 #---------------------------------------------------------------------------
 152 # configuration options related to the man page output
 153 #---------------------------------------------------------------------------
 154 GENERATE_MAN           = NO
 155 MAN_OUTPUT             = man
 156 MAN_EXTENSION          = .3
 157 MAN_LINKS              = NO
 158 #---------------------------------------------------------------------------
 159 # configuration options related to the XML output
 160 #---------------------------------------------------------------------------
 161 GENERATE_XML           = NO
 162 #---------------------------------------------------------------------------
 163 # Configuration options related to the preprocessor
 164 #---------------------------------------------------------------------------
 165 ENABLE_PREPROCESSING   = YES
 166 MACRO_EXPANSION        = NO
 167 EXPAND_ONLY_PREDEF     = NO
 168 SEARCH_INCLUDES        = YES
 169 INCLUDE_PATH           =
 170 INCLUDE_FILE_PATTERNS  =
 171 PREDEFINED             =
 172 EXPAND_AS_DEFINED      =
 173 SKIP_FUNCTION_MACROS   = YES
 174 #---------------------------------------------------------------------------
 175 # Configuration::addtions related to external references
 176 #---------------------------------------------------------------------------
 177 TAGFILES               =
 178 GENERATE_TAGFILE       =
 179 ALLEXTERNALS           = NO
 180 PERL_PATH              = /usr/bin/perl
 181 #---------------------------------------------------------------------------
 182 # Configuration options related to the dot tool
 183 #---------------------------------------------------------------------------
 184 CLASS_DIAGRAMS         = YES
 185 HAVE_DOT               = YES
 186 CLASS_GRAPH            = YES
 187 COLLABORATION_GRAPH    = YES
 188 TEMPLATE_RELATIONS     = YES
 189 HIDE_UNDOC_RELATIONS   = YES
 190 INCLUDE_GRAPH          = YES
 191 INCLUDED_BY_GRAPH      = YES
 192 GRAPHICAL_HIERARCHY    = YES
 193 DOT_PATH               =
 194 DOTFILE_DIRS           =
 195 MAX_DOT_GRAPH_WIDTH    = 1024
 196 MAX_DOT_GRAPH_HEIGHT   = 1024
 197 GENERATE_LEGEND        = YES
 198 DOT_CLEANUP            = YES
 199 #---------------------------------------------------------------------------
 200 # Configuration::addtions related to the search engine
 201 #---------------------------------------------------------------------------
 202 SEARCHENGINE           = NO
 203 CGI_NAME               = search.cgi
 204 CGI_URL                =
 205 DOC_URL                =
 206 DOC_ABSPATH            =
 207 BIN_ABSPATH            = /usr/local/bin/
 208 EXT_DOC_PATHS          =