doc/doxygen/doxyfile.in

   1 # Doxyfile 1.8.5
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = "ParaViS Module v.@SALOMEPARAVIS_VERSION@"
   8 PROJECT_NUMBER         =
   9 PROJECT_BRIEF          =
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       = doc_api
  12 CREATE_SUBDIRS         = NO
  13 OUTPUT_LANGUAGE        = English
  14 BRIEF_MEMBER_DESC      = YES
  15 REPEAT_BRIEF           = NO
  16 ABBREVIATE_BRIEF       =
  17 ALWAYS_DETAILED_SEC    = YES
  18 INLINE_INHERITED_MEMB  = YES
  19 FULL_PATH_NAMES        = YES
  20 STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ \
  21                          @CMAKE_BINARY_DIR@
  22 STRIP_FROM_INC_PATH    =
  23 SHORT_NAMES            = NO
  24 JAVADOC_AUTOBRIEF      = YES
  25 QT_AUTOBRIEF           = NO
  26 MULTILINE_CPP_IS_BRIEF = NO
  27 INHERIT_DOCS           = YES
  28 SEPARATE_MEMBER_PAGES  = NO
  29 TAB_SIZE               = 5
  30 ALIASES                =
  31 TCL_SUBST              =
  32 OPTIMIZE_OUTPUT_FOR_C  = YES
  33 OPTIMIZE_OUTPUT_JAVA   = YES
  34 OPTIMIZE_FOR_FORTRAN   = NO
  35 OPTIMIZE_OUTPUT_VHDL   = NO
  36 EXTENSION_MAPPING      =
  37 MARKDOWN_SUPPORT       = YES
  38 AUTOLINK_SUPPORT       = YES
  39 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
  40 CPP_CLI_SUPPORT        = NO
  41 SIP_SUPPORT            = NO
  42 IDL_PROPERTY_SUPPORT   = YES
  43 DISTRIBUTE_GROUP_DOC   = NO
  44 SUBGROUPING            = YES
  45 INLINE_GROUPED_CLASSES = NO
  46 INLINE_SIMPLE_STRUCTS  = NO
  47 TYPEDEF_HIDES_STRUCT   = NO
  48 LOOKUP_CACHE_SIZE      = 0
  49 #---------------------------------------------------------------------------
  50 # Build related configuration options
  51 #---------------------------------------------------------------------------
  52 EXTRACT_ALL            = YES
  53 EXTRACT_PRIVATE        = YES
  54 EXTRACT_PACKAGE        = NO
  55 EXTRACT_STATIC         = YES
  56 EXTRACT_LOCAL_CLASSES  = YES
  57 EXTRACT_LOCAL_METHODS  = NO
  58 EXTRACT_ANON_NSPACES   = NO
  59 HIDE_UNDOC_MEMBERS     = NO
  60 HIDE_UNDOC_CLASSES     = NO
  61 HIDE_FRIEND_COMPOUNDS  = NO
  62 HIDE_IN_BODY_DOCS      = NO
  63 INTERNAL_DOCS          = YES
  64 CASE_SENSE_NAMES       = YES
  65 HIDE_SCOPE_NAMES       = NO
  66 SHOW_INCLUDE_FILES     = YES
  67 FORCE_LOCAL_INCLUDES   = NO
  68 INLINE_INFO            = YES
  69 SORT_MEMBER_DOCS       = NO
  70 SORT_BRIEF_DOCS        = NO
  71 SORT_MEMBERS_CTORS_1ST = NO
  72 SORT_GROUP_NAMES       = NO
  73 SORT_BY_SCOPE_NAME     = NO
  74 STRICT_PROTO_MATCHING  = NO
  75 GENERATE_TODOLIST      = YES
  76 GENERATE_TESTLIST      = YES
  77 GENERATE_BUGLIST       = YES
  78 GENERATE_DEPRECATEDLIST= YES
  79 ENABLED_SECTIONS       =
  80 MAX_INITIALIZER_LINES  = 25
  81 SHOW_USED_FILES        = NO
  82 SHOW_FILES             = YES
  83 SHOW_NAMESPACES        = YES
  84 FILE_VERSION_FILTER    =
  85 LAYOUT_FILE            =
  86 CITE_BIB_FILES         =
  87 #---------------------------------------------------------------------------
  88 # Configuration options related to warning and progress messages
  89 #---------------------------------------------------------------------------
  90 QUIET                  = NO
  91 WARNINGS               = YES
  92 WARN_IF_UNDOCUMENTED   = YES
  93 WARN_IF_DOC_ERROR      = YES
  94 WARN_NO_PARAMDOC       = NO
  95 WARN_FORMAT            = "$file:$line: $text"
  96 WARN_LOGFILE           =
  97 #---------------------------------------------------------------------------
  98 # Configuration options related to the input files
  99 #---------------------------------------------------------------------------
 100 INPUT                  = @CMAKE_SOURCE_DIR@/src \
 101                          @CMAKE_SOURCE_DIR@/bin \
 102                          @CMAKE_BINARY_DIR@/bin
 103 INPUT_ENCODING         = UTF-8
 104 FILE_PATTERNS          = *.hxx \
 105                          *.cxx \
 106                          *.h \
 107                          *.c \
 108                          *.hh \
 109                          *.cc \
 110                          @DOXYGEN_PYTHON_EXTENSION@
 111 RECURSIVE              = YES
 112 EXCLUDE                =
 113 EXCLUDE_SYMLINKS       = NO
 114 EXCLUDE_PATTERNS       =
 115 EXCLUDE_SYMBOLS        =
 116 EXAMPLE_PATH           =
 117 EXAMPLE_PATTERNS       =
 118 EXAMPLE_RECURSIVE      = NO
 119 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images
 120 INPUT_FILTER           =
 121 FILTER_PATTERNS        =
 122 FILTER_SOURCE_FILES    = YES
 123 FILTER_SOURCE_PATTERNS =
 124 USE_MDFILE_AS_MAINPAGE =
 125 #---------------------------------------------------------------------------
 126 # Configuration options related to source browsing
 127 #---------------------------------------------------------------------------
 128 SOURCE_BROWSER         = NO
 129 INLINE_SOURCES         = NO
 130 STRIP_CODE_COMMENTS    = YES
 131 REFERENCED_BY_RELATION = NO
 132 REFERENCES_RELATION    = YES
 133 REFERENCES_LINK_SOURCE = YES
 134 SOURCE_TOOLTIPS        = YES
 135 USE_HTAGS              = NO
 136 VERBATIM_HEADERS       = YES
 137 #---------------------------------------------------------------------------
 138 # Configuration options related to the alphabetical class index
 139 #---------------------------------------------------------------------------
 140 ALPHABETICAL_INDEX     = YES
 141 COLS_IN_ALPHA_INDEX    = 3
 142 IGNORE_PREFIX          =
 143 #---------------------------------------------------------------------------
 144 # Configuration options related to the HTML output
 145 #---------------------------------------------------------------------------
 146 GENERATE_HTML          = YES
 147 HTML_OUTPUT            = html
 148 HTML_FILE_EXTENSION    = .html
 149 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 150 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 151 HTML_STYLESHEET        =
 152 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
 153 HTML_EXTRA_FILES       =
 154 HTML_COLORSTYLE_HUE    = 220
 155 HTML_COLORSTYLE_SAT    = 100
 156 HTML_COLORSTYLE_GAMMA  = 80
 157 HTML_TIMESTAMP         = NO
 158 HTML_DYNAMIC_SECTIONS  = NO
 159 HTML_INDEX_NUM_ENTRIES = 100
 160 GENERATE_DOCSET        = NO
 161 DOCSET_FEEDNAME        = "Doxygen generated docs"
 162 DOCSET_BUNDLE_ID       = org.doxygen.Project
 163 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 164 DOCSET_PUBLISHER_NAME  = Publisher
 165 GENERATE_HTMLHELP      = NO
 166 CHM_FILE               =
 167 HHC_LOCATION           =
 168 GENERATE_CHI           = YES
 169 CHM_INDEX_ENCODING     =
 170 BINARY_TOC             = NO
 171 TOC_EXPAND             = YES
 172 GENERATE_QHP           = NO
 173 QCH_FILE               =
 174 QHP_NAMESPACE          = org.doxygen.Project
 175 QHP_VIRTUAL_FOLDER     = doc
 176 QHP_CUST_FILTER_NAME   =
 177 QHP_CUST_FILTER_ATTRS  =
 178 QHP_SECT_FILTER_ATTRS  =
 179 QHG_LOCATION           =
 180 GENERATE_ECLIPSEHELP   = NO
 181 ECLIPSE_DOC_ID         = org.doxygen.Project
 182 DISABLE_INDEX          = NO
 183 GENERATE_TREEVIEW      = YES
 184 ENUM_VALUES_PER_LINE   = 4
 185 TREEVIEW_WIDTH         = 250
 186 EXT_LINKS_IN_WINDOW    = NO
 187 FORMULA_FONTSIZE       = 10
 188 FORMULA_TRANSPARENT    = YES
 189 USE_MATHJAX            = NO
 190 MATHJAX_FORMAT         = HTML-CSS
 191 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 192 MATHJAX_EXTENSIONS     =
 193 MATHJAX_CODEFILE       =
 194 SEARCHENGINE           = NO
 195 SERVER_BASED_SEARCH    = NO
 196 EXTERNAL_SEARCH        = NO
 197 SEARCHENGINE_URL       =
 198 SEARCHDATA_FILE        = searchdata.xml
 199 EXTERNAL_SEARCH_ID     =
 200 EXTRA_SEARCH_MAPPINGS  =
 201 #---------------------------------------------------------------------------
 202 # Configuration options related to the LaTeX output
 203 #---------------------------------------------------------------------------
 204 GENERATE_LATEX         = NO
 205 LATEX_OUTPUT           = latex
 206 LATEX_CMD_NAME         = latex
 207 MAKEINDEX_CMD_NAME     = makeindex
 208 COMPACT_LATEX          = NO
 209 PAPER_TYPE             = a4wide
 210 EXTRA_PACKAGES         =
 211 LATEX_HEADER           =
 212 LATEX_FOOTER           =
 213 LATEX_EXTRA_FILES      =
 214 PDF_HYPERLINKS         = NO
 215 USE_PDFLATEX           = NO
 216 LATEX_BATCHMODE        = NO
 217 LATEX_HIDE_INDICES     = NO
 218 LATEX_SOURCE_CODE      = NO
 219 LATEX_BIB_STYLE        = plain
 220 #---------------------------------------------------------------------------
 221 # Configuration options related to the RTF output
 222 #---------------------------------------------------------------------------
 223 GENERATE_RTF           = NO
 224 RTF_OUTPUT             = rtf
 225 COMPACT_RTF            = NO
 226 RTF_HYPERLINKS         = NO
 227 RTF_STYLESHEET_FILE    =
 228 RTF_EXTENSIONS_FILE    =
 229 #---------------------------------------------------------------------------
 230 # Configuration options related to the man page output
 231 #---------------------------------------------------------------------------
 232 GENERATE_MAN           = NO
 233 MAN_OUTPUT             = man
 234 MAN_EXTENSION          = .3
 235 MAN_LINKS              = NO
 236 #---------------------------------------------------------------------------
 237 # Configuration options related to the XML output
 238 #---------------------------------------------------------------------------
 239 GENERATE_XML           = NO
 240 XML_OUTPUT             = xml
 241 XML_SCHEMA             =
 242 XML_DTD                =
 243 XML_PROGRAMLISTING     = YES
 244 #---------------------------------------------------------------------------
 245 # Configuration options related to the DOCBOOK output
 246 #---------------------------------------------------------------------------
 247 GENERATE_DOCBOOK       = NO
 248 DOCBOOK_OUTPUT         = docbook
 249 #---------------------------------------------------------------------------
 250 # Configuration options for the AutoGen Definitions output
 251 #---------------------------------------------------------------------------
 252 GENERATE_AUTOGEN_DEF   = NO
 253 #---------------------------------------------------------------------------
 254 # Configuration options related to the Perl module output
 255 #---------------------------------------------------------------------------
 256 GENERATE_PERLMOD       = NO
 257 PERLMOD_LATEX          = NO
 258 PERLMOD_PRETTY         = YES
 259 PERLMOD_MAKEVAR_PREFIX =
 260 #---------------------------------------------------------------------------
 261 # Configuration options related to the preprocessor
 262 #---------------------------------------------------------------------------
 263 ENABLE_PREPROCESSING   = YES
 264 MACRO_EXPANSION        = NO
 265 EXPAND_ONLY_PREDEF     = NO
 266 SEARCH_INCLUDES        = YES
 267 INCLUDE_PATH           =
 268 INCLUDE_FILE_PATTERNS  =
 269 PREDEFINED             =
 270 EXPAND_AS_DEFINED      =
 271 SKIP_FUNCTION_MACROS   = NO
 272 #---------------------------------------------------------------------------
 273 # Configuration options related to external references
 274 #---------------------------------------------------------------------------
 275 TAGFILES               =
 276 GENERATE_TAGFILE       =
 277 ALLEXTERNALS           = NO
 278 EXTERNAL_GROUPS        = YES
 279 EXTERNAL_PAGES         = YES
 280 PERL_PATH              = /usr/bin/perl
 281 #---------------------------------------------------------------------------
 282 # Configuration options related to the dot tool
 283 #---------------------------------------------------------------------------
 284 CLASS_DIAGRAMS         = YES
 285 MSCGEN_PATH            =
 286 HIDE_UNDOC_RELATIONS   = NO
 287 HAVE_DOT               = YES
 288 DOT_NUM_THREADS        = 0
 289 DOT_FONTNAME           = Arial
 290 DOT_FONTSIZE           = 10
 291 DOT_FONTPATH           =
 292 CLASS_GRAPH            = YES
 293 COLLABORATION_GRAPH    = NO
 294 GROUP_GRAPHS           = NO
 295 UML_LOOK               = NO
 296 UML_LIMIT_NUM_FIELDS   = 10
 297 TEMPLATE_RELATIONS     = YES
 298 INCLUDE_GRAPH          = YES
 299 INCLUDED_BY_GRAPH      = NO
 300 CALL_GRAPH             = NO
 301 CALLER_GRAPH           = NO
 302 GRAPHICAL_HIERARCHY    = YES
 303 DIRECTORY_GRAPH        = YES
 304 DOT_IMAGE_FORMAT       = jpg
 305 INTERACTIVE_SVG        = NO
 306 DOT_PATH               =
 307 DOTFILE_DIRS           =
 308 MSCFILE_DIRS           =
 309 DOT_GRAPH_MAX_NODES    = 50
 310 MAX_DOT_GRAPH_DEPTH    = 0
 311 DOT_TRANSPARENT        = NO
 312 DOT_MULTI_TARGETS      = NO
 313 GENERATE_LEGEND        = NO
 314 DOT_CLEANUP            = YES