doc/salome/gui/SMESH/doxyfile_py.in

   1 #  Copyright (C) 2007-2010  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 # Project related configuration options
  24 #---------------------------------------------------------------------------
  25 PROJECT_NAME           = "SALOME Mesh User's Guide"
  26 OUTPUT_DIRECTORY       = .
  27 CREATE_SUBDIRS         = NO
  28 OUTPUT_LANGUAGE        = English
  29 USE_WINDOWS_ENCODING   = NO
  30 BRIEF_MEMBER_DESC      = YES
  31 REPEAT_BRIEF           = YES
  32 ALWAYS_DETAILED_SEC    = YES
  33 INLINE_INHERITED_MEMB  = YES
  34 FULL_PATH_NAMES        = NO
  35 SHORT_NAMES            = NO
  36 JAVADOC_AUTOBRIEF      = YES
  37 MULTILINE_CPP_IS_BRIEF = NO
  38 DETAILS_AT_TOP         = NO
  39 INHERIT_DOCS           = YES
  40 SEPARATE_MEMBER_PAGES  = NO
  41 TAB_SIZE               = 5
  42 OPTIMIZE_OUTPUT_FOR_C  = YES
  43 OPTIMIZE_OUTPUT_JAVA   = YES
  44 BUILTIN_STL_SUPPORT    = NO
  45 DISTRIBUTE_GROUP_DOC   = NO
  46 SUBGROUPING            = YES
  47
  48 #---------------------------------------------------------------------------
  49 # Build related options
  50 #---------------------------------------------------------------------------
  51 EXTRACT_ALL            = YES
  52 EXTRACT_PRIVATE        = YES
  53 EXTRACT_STATIC         = NO
  54 EXTRACT_LOCAL_CLASSES  = YES
  55 EXTRACT_LOCAL_METHODS  = NO
  56 HIDE_UNDOC_MEMBERS     = NO
  57 HIDE_UNDOC_CLASSES     = NO
  58 HIDE_FRIEND_COMPOUNDS  = NO
  59 HIDE_IN_BODY_DOCS      = NO
  60 INTERNAL_DOCS          = YES
  61 CASE_SENSE_NAMES       = YES
  62 HIDE_SCOPE_NAMES       = YES
  63 SHOW_INCLUDE_FILES     = YES
  64 INLINE_INFO            = YES
  65 SORT_MEMBER_DOCS       = NO
  66 SORT_BRIEF_DOCS        = NO
  67 SORT_BY_SCOPE_NAME     = NO
  68 GENERATE_TODOLIST      = YES
  69 GENERATE_TESTLIST      = YES
  70 GENERATE_BUGLIST       = YES
  71 GENERATE_DEPRECATEDLIST= YES
  72 MAX_INITIALIZER_LINES  = 25
  73 SHOW_USED_FILES        = NO
  74 SHOW_DIRECTORIES       = NO
  75
  76 #---------------------------------------------------------------------------
  77 # configuration options related to source browsing
  78 #---------------------------------------------------------------------------
  79 SOURCE_BROWSER         = NO
  80 INLINE_SOURCES         = NO
  81 STRIP_CODE_COMMENTS    = YES
  82 REFERENCED_BY_RELATION = NO
  83 REFERENCES_RELATION    = YES
  84 USE_HTAGS              = NO
  85 VERBATIM_HEADERS       = YES
  86
  87 #---------------------------------------------------------------------------
  88 # configuration options related to warning and progress messages
  89 #---------------------------------------------------------------------------
  90 QUIET                  = NO
  91 WARNINGS               = YES
  92 WARN_IF_UNDOCUMENTED   = YES
  93 WARN_IF_DOC_ERROR      = YES
  94 WARN_NO_PARAMDOC       = NO
  95 EXCLUDE_SYMLINKS       = NO
  96 EXAMPLE_RECURSIVE      = NO
  97
  98 #---------------------------------------------------------------------------
  99 #Input related options
 100 #---------------------------------------------------------------------------
 101 INPUT             = @top_srcdir@/src/SMESH_SWIG
 102 FILE_PATTERNS     = smeshDC.py
 103 IMAGE_PATH        = @srcdir@/images
 104 RECURSIVE         = NO
 105 EXAMPLE_PATH      = @top_srcdir@/src/SMESH_SWIG
 106
 107 #---------------------------------------------------------------------------
 108 #HTML related options
 109 #---------------------------------------------------------------------------
 110 GENERATE_HTML     = YES
 111 HTML_OUTPUT       = smeshpy_doc
 112 HTML_HEADER       = @builddir@/static/header.html
 113 HTML_FOOTER       = @srcdir@/static/footer.html
 114 HTML_STYLESHEET   = @srcdir@/static/doxygen.css
 115 TOC_EXPAND        = YES
 116 DISABLE_INDEX     = YES
 117 GENERATE_TREEVIEW = NO
 118
 119 #---------------------------------------------------------------------------
 120 #LaTeX related option
 121 #---------------------------------------------------------------------------
 122 GENERATE_LATEX    = NO
 123
 124 #---------------------------------------------------------------------------
 125 #RTF related options
 126 #---------------------------------------------------------------------------
 127 GENERATE_RTF      = NO
 128
 129 #---------------------------------------------------------------------------
 130 # Configuration options related to the dot tool
 131 #---------------------------------------------------------------------------
 132 CLASS_DIAGRAMS         = NO
 133 HIDE_UNDOC_RELATIONS   = NO
 134 HAVE_DOT               = NO
 135 CLASS_GRAPH            = NO
 136 COLLABORATION_GRAPH    = NO
 137 GROUP_GRAPHS           = NO
 138 UML_LOOK               = NO
 139 TEMPLATE_RELATIONS     = NO
 140 INCLUDE_GRAPH          = NO
 141 INCLUDED_BY_GRAPH      = NO
 142 CALL_GRAPH             = NO
 143 GRAPHICAL_HIERARCHY    = NO
 144 DIRECTORY_GRAPH        = NO
 145 DOT_IMAGE_FORMAT       = jpg
 146 DOT_PATH               =
 147 DOTFILE_DIRS           =
 148 MAX_DOT_GRAPH_WIDTH    = 1024
 149 MAX_DOT_GRAPH_HEIGHT   = 1200
 150 MAX_DOT_GRAPH_DEPTH    = 0
 151 DOT_TRANSPARENT        = NO
 152 DOT_MULTI_TARGETS      = NO
 153 GENERATE_LEGEND        = NO
 154 DOT_CLEANUP            = YES
 155
 156 #---------------------------------------------------------------------------
 157 #External reference options
 158 #---------------------------------------------------------------------------
 159 GENERATE_TAGFILE  = smeshpy_doc.tag
 160 SEARCHENGINE           = YES