doc/salome/gui/SMESH/doxyfile_py.in

   1 #---------------------------------------------------------------------------
   2 # Project related configuration options
   3 #---------------------------------------------------------------------------
   4 PROJECT_NAME      = "Mesh Module Reference Manual v.@VERSION@"
   5 OUTPUT_DIRECTORY  = ./
   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             = @top_srcdir@/src/SMESH_SWIG
  81 FILE_PATTERNS     = smeshDC.py
  82 IMAGE_PATH        = @srcdir@/images
  83 RECURSIVE         = NO
  84 EXAMPLE_PATH      = @top_srcdir@/src/SMESH_SWIG
  85
  86 #---------------------------------------------------------------------------
  87 #HTML related options
  88 #---------------------------------------------------------------------------
  89 GENERATE_HTML     = YES
  90 HTML_OUTPUT       = ./smeshpy_doc
  91 HTML_HEADER       = @srcdir@/static/header.html
  92 HTML_FOOTER       = @srcdir@/static/footer.html
  93 #HTML_STYLESHEET  = @srcdir@/static/doxygen.css
  94 TOC_EXPAND        = YES
  95 DISABLE_INDEX     = YES
  96 GENERATE_TREEVIEW = NO
  97
  98 #---------------------------------------------------------------------------
  99 #LaTeX related option
 100 #---------------------------------------------------------------------------
 101 GENERATE_LATEX    = NO
 102
 103 #---------------------------------------------------------------------------
 104 #RTF related options
 105 #---------------------------------------------------------------------------
 106 GENERATE_RTF      = NO
 107
 108 #---------------------------------------------------------------------------
 109 # Configuration options related to the dot tool
 110 #---------------------------------------------------------------------------
 111 #CLASS_DIAGRAMS         = YES
 112 CLASS_DIAGRAMS         = NO
 113 HIDE_UNDOC_RELATIONS   = NO
 114 #HAVE_DOT               = YES
 115 HAVE_DOT               = NO
 116 #CLASS_GRAPH            = YES
 117 CLASS_GRAPH            = NO
 118 COLLABORATION_GRAPH    = NO
 119 GROUP_GRAPHS           = NO
 120 UML_LOOK               = NO
 121 #TEMPLATE_RELATIONS     = YES
 122 #INCLUDE_GRAPH          = YES
 123 TEMPLATE_RELATIONS     = NO
 124 INCLUDE_GRAPH          = NO
 125 INCLUDED_BY_GRAPH      = NO
 126 CALL_GRAPH             = NO
 127 #GRAPHICAL_HIERARCHY    = YES
 128 #DIRECTORY_GRAPH        = YES
 129 GRAPHICAL_HIERARCHY    = NO
 130 DIRECTORY_GRAPH        = NO
 131 DOT_IMAGE_FORMAT       = jpg
 132 DOT_PATH               =
 133 DOTFILE_DIRS           =
 134 MAX_DOT_GRAPH_WIDTH    = 1024
 135 MAX_DOT_GRAPH_HEIGHT   = 1200
 136 MAX_DOT_GRAPH_DEPTH    = 0
 137 DOT_TRANSPARENT        = NO
 138 DOT_MULTI_TARGETS      = NO
 139 GENERATE_LEGEND        = NO
 140 DOT_CLEANUP            = YES
 141
 142 #---------------------------------------------------------------------------
 143 #External reference options
 144 #---------------------------------------------------------------------------
 145 GENERATE_TAGFILE  = smeshpy_doc.tag