doc/salome/gui/HYBRIDPLUGIN/doxyfile_py.in

   1 #---------------------------------------------------------------------------
   2 # Project related configuration options
   3 #---------------------------------------------------------------------------
   4 PROJECT_NAME           = "SALOME HYBRIDPLUGIN User's Guide"
   5 OUTPUT_DIRECTORY       = HYBRIDPLUGIN
   6 CREATE_SUBDIRS         = NO
   7 OUTPUT_LANGUAGE        = English
   8 USE_WINDOWS_ENCODING   = NO
   9 BRIEF_MEMBER_DESC      = YES
  10 REPEAT_BRIEF           = YES
  11 ALWAYS_DETAILED_SEC    = YES
  12 INLINE_INHERITED_MEMB  = YES
  13 FULL_PATH_NAMES        = NO
  14 SHORT_NAMES            = NO
  15 JAVADOC_AUTOBRIEF      = YES
  16 MULTILINE_CPP_IS_BRIEF = NO
  17 DETAILS_AT_TOP         = NO
  18 INHERIT_DOCS           = YES
  19 SEPARATE_MEMBER_PAGES  = NO
  20 TAB_SIZE               = 5
  21 OPTIMIZE_OUTPUT_FOR_C  = YES
  22 OPTIMIZE_OUTPUT_JAVA   = YES
  23 BUILTIN_STL_SUPPORT    = NO
  24 DISTRIBUTE_GROUP_DOC   = NO
  25 SUBGROUPING            = YES
  26
  27 #---------------------------------------------------------------------------
  28 # Build related options
  29 #---------------------------------------------------------------------------
  30 EXTRACT_ALL            = YES
  31 EXTRACT_PRIVATE        = YES
  32 EXTRACT_STATIC         = NO
  33 EXTRACT_LOCAL_CLASSES  = YES
  34 EXTRACT_LOCAL_METHODS  = NO
  35 HIDE_UNDOC_MEMBERS     = NO
  36 HIDE_UNDOC_CLASSES     = NO
  37 HIDE_FRIEND_COMPOUNDS  = NO
  38 HIDE_IN_BODY_DOCS      = NO
  39 INTERNAL_DOCS          = YES
  40 CASE_SENSE_NAMES       = YES
  41 HIDE_SCOPE_NAMES       = YES
  42 SHOW_INCLUDE_FILES     = YES
  43 INLINE_INFO            = YES
  44 SORT_MEMBER_DOCS       = NO
  45 SORT_BRIEF_DOCS        = NO
  46 SORT_BY_SCOPE_NAME     = NO
  47 GENERATE_TODOLIST      = YES
  48 GENERATE_TESTLIST      = YES
  49 GENERATE_BUGLIST       = YES
  50 GENERATE_DEPRECATEDLIST= YES
  51 MAX_INITIALIZER_LINES  = 25
  52 SHOW_USED_FILES        = NO
  53 SHOW_DIRECTORIES       = NO
  54
  55 #---------------------------------------------------------------------------
  56 # configuration options related to source browsing
  57 #---------------------------------------------------------------------------
  58 SOURCE_BROWSER         = NO
  59 INLINE_SOURCES         = NO
  60 STRIP_CODE_COMMENTS    = YES
  61 REFERENCED_BY_RELATION = NO
  62 REFERENCES_RELATION    = YES
  63 USE_HTAGS              = NO
  64 VERBATIM_HEADERS       = YES
  65
  66 #---------------------------------------------------------------------------
  67 # configuration options related to warning and progress messages
  68 #---------------------------------------------------------------------------
  69 QUIET                  = NO
  70 WARNINGS               = YES
  71 WARN_IF_UNDOCUMENTED   = YES
  72 WARN_IF_DOC_ERROR      = YES
  73 WARN_NO_PARAMDOC       = NO
  74 EXCLUDE_SYMLINKS       = NO
  75 EXAMPLE_RECURSIVE      = NO
  76
  77 #---------------------------------------------------------------------------
  78 #Input related options
  79 #---------------------------------------------------------------------------
  80 INPUT             = tmp/HYBRIDPluginBuilder.py \
  81                     tmp/smeshBuilder.py \
  82                     tmp/smesh_algorithm.py
  83 FILE_PATTERNS     =
  84 IMAGE_PATH        = @CMAKE_CURRENT_SOURCE_DIR@/images
  85 RECURSIVE         = NO
  86 EXAMPLE_PATH      =
  87
  88 #---------------------------------------------------------------------------
  89 #HTML related options
  90 #---------------------------------------------------------------------------
  91 GENERATE_HTML     = YES
  92 HTML_OUTPUT       = hybridpluginpy_doc
  93 HTML_HEADER       = @CMAKE_CURRENT_BINARY_DIR@/static/header_py.html
  94 HTML_FOOTER       = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
  95 HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
  96 HTML_EXTRA_FILES      = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png
  97 TOC_EXPAND        = YES
  98 DISABLE_INDEX     = NO
  99 GENERATE_TREEVIEW = YES
 100 TREEVIEW_WIDTH    = 300
 101
 102 #---------------------------------------------------------------------------
 103 #LaTeX related option
 104 #---------------------------------------------------------------------------
 105 GENERATE_LATEX    = NO
 106
 107 #---------------------------------------------------------------------------
 108 #RTF related options
 109 #---------------------------------------------------------------------------
 110 GENERATE_RTF      = NO
 111
 112 #---------------------------------------------------------------------------
 113 # Configuration options related to the dot tool
 114 #---------------------------------------------------------------------------
 115 CLASS_DIAGRAMS         = NO
 116 HIDE_UNDOC_RELATIONS   = NO
 117 HAVE_DOT               = YES
 118 CLASS_GRAPH            = YES
 119 COLLABORATION_GRAPH    = NO
 120 GROUP_GRAPHS           = NO
 121 UML_LOOK               = NO
 122 TEMPLATE_RELATIONS     = YES
 123 INCLUDE_GRAPH          = YES
 124 INCLUDED_BY_GRAPH      = YES
 125 CALL_GRAPH             = NO
 126 GRAPHICAL_HIERARCHY    = YES
 127 DIRECTORY_GRAPH        = YES
 128 DOT_IMAGE_FORMAT       = png
 129 DOT_FONTNAME           = Arial
 130 DOT_PATH               =
 131 DOTFILE_DIRS           =
 132 MAX_DOT_GRAPH_WIDTH    = 1024
 133 MAX_DOT_GRAPH_HEIGHT   = 1024
 134 MAX_DOT_GRAPH_DEPTH    = 1000
 135 DOT_TRANSPARENT        = NO
 136 DOT_MULTI_TARGETS      = NO
 137 GENERATE_LEGEND        = NO
 138 DOT_CLEANUP            = YES
 139
 140 #---------------------------------------------------------------------------
 141 #External reference options
 142 #---------------------------------------------------------------------------
 143 GENERATE_TAGFILE  = hybridpluginpy_doc.tag
 144 SEARCHENGINE           = YES