doc/salome/gui/SMESH/doxyfile_py.in

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