doc/salome/gui/HexoticPLUGIN/doxyfile_py.in

   1 # Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   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 #---------------------------------------------------------------------------
  21 # Project related configuration options
  22 #---------------------------------------------------------------------------
  23 PROJECT_NAME           = "SALOME HexoticPLUGIN User's Guide"
  24 OUTPUT_DIRECTORY       = .
  25 CREATE_SUBDIRS         = NO
  26 OUTPUT_LANGUAGE        = English
  27 USE_WINDOWS_ENCODING   = NO
  28 BRIEF_MEMBER_DESC      = YES
  29 REPEAT_BRIEF           = YES
  30 ALWAYS_DETAILED_SEC    = YES
  31 INLINE_INHERITED_MEMB  = YES
  32 FULL_PATH_NAMES        = NO
  33 SHORT_NAMES            = NO
  34 JAVADOC_AUTOBRIEF      = YES
  35 MULTILINE_CPP_IS_BRIEF = NO
  36 DETAILS_AT_TOP         = NO
  37 INHERIT_DOCS           = YES
  38 SEPARATE_MEMBER_PAGES  = NO
  39 TAB_SIZE               = 5
  40 OPTIMIZE_OUTPUT_FOR_C  = YES
  41 OPTIMIZE_OUTPUT_JAVA   = YES
  42 BUILTIN_STL_SUPPORT    = NO
  43 DISTRIBUTE_GROUP_DOC   = NO
  44 SUBGROUPING            = YES
  45
  46 #---------------------------------------------------------------------------
  47 # Build related options
  48 #---------------------------------------------------------------------------
  49 EXTRACT_ALL            = YES
  50 EXTRACT_PRIVATE        = YES
  51 EXTRACT_STATIC         = NO
  52 EXTRACT_LOCAL_CLASSES  = YES
  53 EXTRACT_LOCAL_METHODS  = NO
  54 HIDE_UNDOC_MEMBERS     = NO
  55 HIDE_UNDOC_CLASSES     = NO
  56 HIDE_FRIEND_COMPOUNDS  = NO
  57 HIDE_IN_BODY_DOCS      = NO
  58 INTERNAL_DOCS          = YES
  59 CASE_SENSE_NAMES       = YES
  60 HIDE_SCOPE_NAMES       = YES
  61 SHOW_INCLUDE_FILES     = YES
  62 INLINE_INFO            = YES
  63 SORT_MEMBER_DOCS       = NO
  64 SORT_BRIEF_DOCS        = NO
  65 SORT_BY_SCOPE_NAME     = NO
  66 GENERATE_TODOLIST      = YES
  67 GENERATE_TESTLIST      = YES
  68 GENERATE_BUGLIST       = YES
  69 GENERATE_DEPRECATEDLIST= YES
  70 MAX_INITIALIZER_LINES  = 25
  71 SHOW_USED_FILES        = NO
  72 SHOW_DIRECTORIES       = NO
  73
  74 #---------------------------------------------------------------------------
  75 # configuration options related to source browsing
  76 #---------------------------------------------------------------------------
  77 SOURCE_BROWSER         = NO
  78 INLINE_SOURCES         = NO
  79 STRIP_CODE_COMMENTS    = YES
  80 REFERENCED_BY_RELATION = NO
  81 REFERENCES_RELATION    = YES
  82 USE_HTAGS              = NO
  83 VERBATIM_HEADERS       = YES
  84
  85 #---------------------------------------------------------------------------
  86 # configuration options related to warning and progress messages
  87 #---------------------------------------------------------------------------
  88 QUIET                  = NO
  89 WARNINGS               = YES
  90 WARN_IF_UNDOCUMENTED   = YES
  91 WARN_IF_DOC_ERROR      = YES
  92 WARN_NO_PARAMDOC       = NO
  93 EXCLUDE_SYMLINKS       = NO
  94 EXAMPLE_RECURSIVE      = NO
  95
  96 #---------------------------------------------------------------------------
  97 #Input related options
  98 #---------------------------------------------------------------------------
  99 INPUT             = @top_srcdir@/src/HexoticPlugin/HexoticPLUGINBuilder.py \
 100                     smeshBuilder.py \
 101                     @SMESH_ROOT_DIR@/lib/python@PYTHON_VERSION@/site-packages/salome/salome/smesh/smesh_algorithm.py
 102 FILE_PATTERNS     =
 103 IMAGE_PATH        = @srcdir@/images
 104 RECURSIVE         = NO
 105 EXAMPLE_PATH      =
 106
 107 #---------------------------------------------------------------------------
 108 #HTML related options
 109 #---------------------------------------------------------------------------
 110 GENERATE_HTML     = YES
 111 HTML_OUTPUT       = hexoticpluginpy_doc
 112 HTML_HEADER       = @builddir@/static/header_py.html
 113 HTML_FOOTER       = @srcdir@/static/footer.html
 114 HTML_STYLESHEET   = @srcdir@/static/doxygen.css
 115 TOC_EXPAND        = YES
 116 DISABLE_INDEX     = NO
 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               = YES
 135 CLASS_GRAPH            = YES
 136 COLLABORATION_GRAPH    = NO
 137 GROUP_GRAPHS           = NO
 138 UML_LOOK               = NO
 139 TEMPLATE_RELATIONS     = YES
 140 INCLUDE_GRAPH          = YES
 141 INCLUDED_BY_GRAPH      = YES
 142 CALL_GRAPH             = NO
 143 GRAPHICAL_HIERARCHY    = YES
 144 DIRECTORY_GRAPH        = YES
 145 DOT_IMAGE_FORMAT       = png
 146 DOT_FONTNAME           = Arial
 147 DOT_PATH               =
 148 DOTFILE_DIRS           =
 149 MAX_DOT_GRAPH_WIDTH    = 1024
 150 MAX_DOT_GRAPH_HEIGHT   = 1024
 151 MAX_DOT_GRAPH_DEPTH    = 1000
 152 DOT_TRANSPARENT        = NO
 153 DOT_MULTI_TARGETS      = NO
 154 GENERATE_LEGEND        = NO
 155 DOT_CLEANUP            = YES
 156
 157 #---------------------------------------------------------------------------
 158 #External reference options
 159 #---------------------------------------------------------------------------
 160 GENERATE_TAGFILE  = hexoticpluginpy_doc.tag
 161 SEARCHENGINE           = YES