doc/salome/tui/doxyfile.in

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