doc/Doxyfile

   1 # Copyright (C) 2006-2012  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.
   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 1.4.2
  21 #---------------------------------------------------------------------------
  22 # Project related configuration options
  23 #---------------------------------------------------------------------------
  24 #
  25 PROJECT_NAME           = YACS
  26 PROJECT_NUMBER         = 0.0.1
  27 OUTPUT_DIRECTORY       = /home/prascle/SALOME2/YACS/BR_V0_0_1_PR/doc/
  28 CREATE_SUBDIRS         = NO
  29 OUTPUT_LANGUAGE        = English
  30 USE_WINDOWS_ENCODING   = NO
  31 BRIEF_MEMBER_DESC      = YES
  32 REPEAT_BRIEF           = YES
  33 ABBREVIATE_BRIEF       = "The $name class" \
  34                          "The $name widget" \
  35                          "The $name file" \
  36                          is \
  37                          provides \
  38                          specifies \
  39                          contains \
  40                          represents \
  41                          a \
  42                          an \
  43                          the
  44 ALWAYS_DETAILED_SEC    = NO
  45 INLINE_INHERITED_MEMB  = NO
  46 FULL_PATH_NAMES        = YES
  47 STRIP_FROM_PATH        = /home/prascle/SALOME2/YACS/BR_V0_0_1_PR
  48 STRIP_FROM_INC_PATH    =
  49 SHORT_NAMES            = NO
  50 JAVADOC_AUTOBRIEF      = NO
  51 MULTILINE_CPP_IS_BRIEF = NO
  52 DETAILS_AT_TOP         = NO
  53 INHERIT_DOCS           = YES
  54 DISTRIBUTE_GROUP_DOC   = NO
  55 SEPARATE_MEMBER_PAGES  = NO
  56 TAB_SIZE               = 8
  57 ALIASES                =
  58 OPTIMIZE_OUTPUT_FOR_C  = NO
  59 OPTIMIZE_OUTPUT_JAVA   = NO
  60 SUBGROUPING            = YES
  61 #---------------------------------------------------------------------------
  62 # Build related configuration options
  63 #---------------------------------------------------------------------------
  64 EXTRACT_ALL            = YES
  65 EXTRACT_PRIVATE        = YES
  66 EXTRACT_STATIC         = YES
  67 EXTRACT_LOCAL_CLASSES  = YES
  68 EXTRACT_LOCAL_METHODS  = NO
  69 HIDE_UNDOC_MEMBERS     = NO
  70 HIDE_UNDOC_CLASSES     = NO
  71 HIDE_FRIEND_COMPOUNDS  = NO
  72 HIDE_IN_BODY_DOCS      = NO
  73 INTERNAL_DOCS          = NO
  74 CASE_SENSE_NAMES       = YES
  75 HIDE_SCOPE_NAMES       = NO
  76 SHOW_INCLUDE_FILES     = YES
  77 INLINE_INFO            = YES
  78 SORT_MEMBER_DOCS       = YES
  79 SORT_BRIEF_DOCS        = NO
  80 SORT_BY_SCOPE_NAME     = NO
  81 GENERATE_TODOLIST      = YES
  82 GENERATE_TESTLIST      = YES
  83 GENERATE_BUGLIST       = YES
  84 GENERATE_DEPRECATEDLIST= YES
  85 ENABLED_SECTIONS       =
  86 MAX_INITIALIZER_LINES  = 30
  87 SHOW_USED_FILES        = YES
  88 SHOW_DIRECTORIES       = YES
  89 FILE_VERSION_FILTER    =
  90 #---------------------------------------------------------------------------
  91 # configuration options related to warning and progress messages
  92 #---------------------------------------------------------------------------
  93 QUIET                  = NO
  94 WARNINGS               = YES
  95 WARN_IF_UNDOCUMENTED   = YES
  96 WARN_IF_DOC_ERROR      = YES
  97 WARN_NO_PARAMDOC       = NO
  98 WARN_FORMAT            = "$file:$line: $text"
  99 WARN_LOGFILE           =
 100 #---------------------------------------------------------------------------
 101 # configuration options related to the input files
 102 #---------------------------------------------------------------------------
 103 INPUT                  =  \
 104    /home/prascle/SALOME2/YACS/BR_V0_0_1_PR/YACS_SRC/src/bases \
 105    /home/prascle/SALOME2/YACS/BR_V0_0_1_PR/YACS_SRC/src/data \
 106    /home/prascle/SALOME2/YACS/BR_V0_0_1_PR/YACS_SRC/src/engine \
 107    /home/prascle/SALOME2/YACS/BR_V0_0_1_PR/YACS_SRC/src/runtime
 108 FILE_PATTERNS          = *.c \
 109                          *.cc \
 110                          *.cxx \
 111                          *.cpp \
 112                          *.c++ \
 113                          *.d \
 114                          *.java \
 115                          *.ii \
 116                          *.ixx \
 117                          *.ipp \
 118                          *.i++ \
 119                          *.inl \
 120                          *.h \
 121                          *.hh \
 122                          *.hxx \
 123                          *.hpp \
 124                          *.h++ \
 125                          *.idl \
 126                          *.odl \
 127                          *.cs \
 128                          *.php \
 129                          *.php3 \
 130                          *.inc \
 131                          *.m \
 132                          *.mm \
 133                          *.dox \
 134                          *.C \
 135                          *.CC \
 136                          *.C++ \
 137                          *.II \
 138                          *.I++ \
 139                          *.H \
 140                          *.HH \
 141                          *.H++ \
 142                          *.CS \
 143                          *.PHP \
 144                          *.PHP3 \
 145                          *.M \
 146                          *.MM
 147 RECURSIVE              = YES
 148 EXCLUDE                =
 149 EXCLUDE_SYMLINKS       = NO
 150 EXCLUDE_PATTERNS       =
 151 EXAMPLE_PATH           =
 152 EXAMPLE_PATTERNS       = *
 153 EXAMPLE_RECURSIVE      = NO
 154 IMAGE_PATH             =
 155 INPUT_FILTER           =
 156 FILTER_PATTERNS        =
 157 FILTER_SOURCE_FILES    = NO
 158 #---------------------------------------------------------------------------
 159 # configuration options related to source browsing
 160 #---------------------------------------------------------------------------
 161 SOURCE_BROWSER         = YES
 162 INLINE_SOURCES         = NO
 163 STRIP_CODE_COMMENTS    = YES
 164 REFERENCED_BY_RELATION = YES
 165 REFERENCES_RELATION    = YES
 166 VERBATIM_HEADERS       = YES
 167 #---------------------------------------------------------------------------
 168 # configuration options related to the alphabetical class index
 169 #---------------------------------------------------------------------------
 170 ALPHABETICAL_INDEX     = NO
 171 COLS_IN_ALPHA_INDEX    = 5
 172 IGNORE_PREFIX          =
 173 #---------------------------------------------------------------------------
 174 # configuration options related to the HTML output
 175 #---------------------------------------------------------------------------
 176 GENERATE_HTML          = YES
 177 HTML_OUTPUT            = html
 178 HTML_FILE_EXTENSION    = .html
 179 HTML_HEADER            =
 180 HTML_FOOTER            =
 181 HTML_STYLESHEET        =
 182 HTML_ALIGN_MEMBERS     = YES
 183 GENERATE_HTMLHELP      = NO
 184 CHM_FILE               =
 185 HHC_LOCATION           =
 186 GENERATE_CHI           = NO
 187 BINARY_TOC             = NO
 188 TOC_EXPAND             = NO
 189 DISABLE_INDEX          = NO
 190 ENUM_VALUES_PER_LINE   = 4
 191 GENERATE_TREEVIEW      = YES
 192 TREEVIEW_WIDTH         = 250
 193 #---------------------------------------------------------------------------
 194 # configuration options related to the LaTeX output
 195 #---------------------------------------------------------------------------
 196 GENERATE_LATEX         = NO
 197 LATEX_OUTPUT           = latex
 198 LATEX_CMD_NAME         = latex
 199 MAKEINDEX_CMD_NAME     = makeindex
 200 COMPACT_LATEX          = NO
 201 PAPER_TYPE             = a4wide
 202 EXTRA_PACKAGES         =
 203 LATEX_HEADER           =
 204 PDF_HYPERLINKS         = NO
 205 USE_PDFLATEX           = NO
 206 LATEX_BATCHMODE        = NO
 207 LATEX_HIDE_INDICES     = NO
 208 #---------------------------------------------------------------------------
 209 # configuration options related to the RTF output
 210 #---------------------------------------------------------------------------
 211 GENERATE_RTF           = NO
 212 RTF_OUTPUT             = rtf
 213 COMPACT_RTF            = NO
 214 RTF_HYPERLINKS         = NO
 215 RTF_STYLESHEET_FILE    =
 216 RTF_EXTENSIONS_FILE    =
 217 #---------------------------------------------------------------------------
 218 # configuration options related to the man page output
 219 #---------------------------------------------------------------------------
 220 GENERATE_MAN           = NO
 221 MAN_OUTPUT             = man
 222 MAN_EXTENSION          = .3
 223 MAN_LINKS              = NO
 224 #---------------------------------------------------------------------------
 225 # configuration options related to the XML output
 226 #---------------------------------------------------------------------------
 227 GENERATE_XML           = NO
 228 XML_OUTPUT             = xml
 229 XML_SCHEMA             =
 230 XML_DTD                =
 231 XML_PROGRAMLISTING     = YES
 232 #---------------------------------------------------------------------------
 233 # configuration options for the AutoGen Definitions output
 234 #---------------------------------------------------------------------------
 235 GENERATE_AUTOGEN_DEF   = NO
 236 #---------------------------------------------------------------------------
 237 # configuration options related to the Perl module output
 238 #---------------------------------------------------------------------------
 239 GENERATE_PERLMOD       = NO
 240 PERLMOD_LATEX          = NO
 241 PERLMOD_PRETTY         = YES
 242 PERLMOD_MAKEVAR_PREFIX =
 243 #---------------------------------------------------------------------------
 244 # Configuration options related to the preprocessor
 245 #---------------------------------------------------------------------------
 246 ENABLE_PREPROCESSING   = YES
 247 MACRO_EXPANSION        = NO
 248 EXPAND_ONLY_PREDEF     = NO
 249 SEARCH_INCLUDES        = YES
 250 INCLUDE_PATH           =
 251 INCLUDE_FILE_PATTERNS  =
 252 PREDEFINED             =
 253 EXPAND_AS_DEFINED      =
 254 SKIP_FUNCTION_MACROS   = YES
 255 #---------------------------------------------------------------------------
 256 # Configuration::additions related to external references
 257 #---------------------------------------------------------------------------
 258 TAGFILES               =
 259 GENERATE_TAGFILE       =
 260 ALLEXTERNALS           = NO
 261 EXTERNAL_GROUPS        = YES
 262 PERL_PATH              = /usr/bin/perl
 263 #---------------------------------------------------------------------------
 264 # Configuration options related to the dot tool
 265 #---------------------------------------------------------------------------
 266 CLASS_DIAGRAMS         = YES
 267 HIDE_UNDOC_RELATIONS   = YES
 268 HAVE_DOT               = NO
 269 CLASS_GRAPH            = YES
 270 COLLABORATION_GRAPH    = YES
 271 GROUP_GRAPHS           = YES
 272 UML_LOOK               = NO
 273 TEMPLATE_RELATIONS     = NO
 274 INCLUDE_GRAPH          = YES
 275 INCLUDED_BY_GRAPH      = YES
 276 CALL_GRAPH             = NO
 277 GRAPHICAL_HIERARCHY    = YES
 278 DIRECTORY_GRAPH        = YES
 279 DOT_IMAGE_FORMAT       = png
 280 DOT_PATH               =
 281 DOTFILE_DIRS           =
 282 MAX_DOT_GRAPH_WIDTH    = 1024
 283 MAX_DOT_GRAPH_HEIGHT   = 1024
 284 MAX_DOT_GRAPH_DEPTH    = 1000
 285 DOT_TRANSPARENT        = NO
 286 DOT_MULTI_TARGETS      = NO
 287 GENERATE_LEGEND        = YES
 288 DOT_CLEANUP            = YES
 289 #---------------------------------------------------------------------------
 290 # Configuration::additions related to the search engine
 291 #---------------------------------------------------------------------------
 292 SEARCHENGINE           = NO