doc/salome/tui/doxyfile.in

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