doc/salome/tui/doxyfile.in

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