]> SALOME platform Git repositories - plugins/blsurfplugin.git/commitdiff
Salome HOME
*** empty log message ***
authorrnv <rnv@opencascade.com>
Wed, 28 Mar 2012 06:33:26 +0000 (06:33 +0000)
committerrnv <rnv@opencascade.com>
Wed, 28 Mar 2012 06:33:26 +0000 (06:33 +0000)
15 files changed:
doc/salome/gui/BLSURFPLUGIN/Makefile.am [new file with mode: 0644]
doc/salome/gui/BLSURFPLUGIN/doxyfile.in [new file with mode: 0755]
doc/salome/gui/BLSURFPLUGIN/doxyfile_py.in [new file with mode: 0755]
doc/salome/gui/doxyfile.in [deleted file]
doc/salome/gui/images/blsurf_attractors.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_attractors2.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_const_size_near_shape.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_const_size_near_shape2.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_parameters.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_parameters_advanced.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_parameters_enforced_vertices.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_parameters_sizemap.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_parameters_sizemap1.png [new file with mode: 0644]
doc/salome/gui/images/blsurf_parameters_sizemap2.png [new file with mode: 0644]
doc/salome/gui/images/empty [deleted file]

diff --git a/doc/salome/gui/BLSURFPLUGIN/Makefile.am b/doc/salome/gui/BLSURFPLUGIN/Makefile.am
new file mode 100644 (file)
index 0000000..70a5302
--- /dev/null
@@ -0,0 +1,66 @@
+# Copyright (C) 2007-2011  CEA/DEN, EDF R&D
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+#  File   : Makefile.in
+#  Author : Vasily Rusyaev (Open Cascade NN)
+#  Module : doc
+#
+include $(top_srcdir)/adm_local/unix/make_common_starter.am
+
+EXTRA_DIST += images input static/footer.html static/doxygen.css
+
+guidocdir = $(docdir)/gui/BLSURFPLUGIN
+guidoc_DATA = images/head.png
+
+
+usr_docs: doxyfile
+       echo "===========================================" ;                    \
+       echo "Generating Python interface documentation";                       \
+       echo "===========================================" ;                    \
+       $(DOXYGEN) doxyfile_py                                                  \
+       echo "===========================================" ;                    \
+       echo "Generating GUI documentation" ;                                   \
+       echo "===========================================" ;                    \
+       $(DOXYGEN) doxyfile ;
+
+docs: usr_docs
+
+clean-local:
+       @for filen in `find . -maxdepth 1` ; do                 \
+         case $${filen} in                                     \
+           ./Makefile | ./doxyfile | ./doxyfile_py ) ;;        \
+           . | .. | ./static ) ;;                              \
+           *) echo "Removing $${filen}" ; rm -rf $${filen} ;;  \
+         esac ;                                                \
+       done ;
+
+install-data-local: usr_docs
+       $(INSTALL) -d $(DESTDIR)$(docdir)/gui/BLSURFPLUGIN
+       @for filen in `find . -maxdepth 1` ; do                                                 \
+         case $${filen} in                                                                     \
+           ./Makefile | ./doxyfile | ./doxyfile_py ) ;;                                        \
+           ./doxyfile.bak | ./doxyfile_py.bak ) ;;                                             \
+           . | .. | ./static ) ;;                                                              \
+           *) echo "Installing $${filen}" ; cp -rp $${filen} $(DESTDIR)$(docdir)/gui/BLSURFPLUGIN ;;   \
+         esac ;                                                                                \
+       done ;
+       cp -rp $(srcdir)/images/head.png $(DESTDIR)$(docdir)/gui/BLSURFPLUGIN/blsurfpluginpy_doc/ ;
+
+uninstall-local:
+       rm -rf $(DESTDIR)$(docdir)/gui/BLSURFPLUGIN
\ No newline at end of file
diff --git a/doc/salome/gui/BLSURFPLUGIN/doxyfile.in b/doc/salome/gui/BLSURFPLUGIN/doxyfile.in
new file mode 100755 (executable)
index 0000000..a977637
--- /dev/null
@@ -0,0 +1,72 @@
+# Copyright (C) 2007-2011  CEA/DEN, EDF R&D
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME      = "BLSURFPLUGIN Module Reference Manual v.@VERSION@"
+OUTPUT_DIRECTORY  = .
+CREATE_SUBDIRS   = NO
+OUTPUT_LANGUAGE   = English
+TAB_SIZE          = 5
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET             = NO
+WARNINGS          = YES
+
+#---------------------------------------------------------------------------
+#Input related options
+#---------------------------------------------------------------------------
+INPUT             = @srcdir@/input
+FILE_PATTERNS     = *.doc
+IMAGE_PATH        = @srcdir@/images
+
+#---------------------------------------------------------------------------
+#HTML related options
+#---------------------------------------------------------------------------
+GENERATE_HTML     = YES
+HTML_OUTPUT       = .
+HTML_HEADER       = @builddir@/static/header.html
+HTML_FOOTER       = @srcdir@/static/footer.html
+HTML_STYLESHEET  = @srcdir@/static/doxygen.css
+TOC_EXPAND        = YES
+DISABLE_INDEX     = NO
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH    = 300
+
+#---------------------------------------------------------------------------
+#LaTeX related option
+#---------------------------------------------------------------------------
+GENERATE_LATEX    = NO
+
+#---------------------------------------------------------------------------
+#RTF related options
+#---------------------------------------------------------------------------
+GENERATE_RTF      = NO
+
+#---------------------------------------------------------------------------
+#External reference options
+#---------------------------------------------------------------------------
+
+#rnv: 07.04.2011 Workaround for the doxygen 1.7.3:
+#because it wrongly defines location of the html files for search.
+TAGFILES          = blsurfpluginpy_doc.tag=../BLSURFPLUGIN/blsurfpluginpy_doc
+SEARCHENGINE      = YES
\ No newline at end of file
diff --git a/doc/salome/gui/BLSURFPLUGIN/doxyfile_py.in b/doc/salome/gui/BLSURFPLUGIN/doxyfile_py.in
new file mode 100755 (executable)
index 0000000..71047e7
--- /dev/null
@@ -0,0 +1,162 @@
+# Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
+#
+# Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME           = "SALOME BLSURFPLUGIN User's Guide"
+OUTPUT_DIRECTORY       = .
+CREATE_SUBDIRS        = NO
+OUTPUT_LANGUAGE        = English
+USE_WINDOWS_ENCODING   = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ALWAYS_DETAILED_SEC    = YES
+INLINE_INHERITED_MEMB  = YES
+FULL_PATH_NAMES        = NO
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP         = NO
+INHERIT_DOCS           = YES
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 5
+OPTIMIZE_OUTPUT_FOR_C  = YES
+OPTIMIZE_OUTPUT_JAVA   = YES
+BUILTIN_STL_SUPPORT    = NO
+DISTRIBUTE_GROUP_DOC   = NO
+SUBGROUPING            = YES
+
+#---------------------------------------------------------------------------
+# Build related options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = YES
+EXTRACT_STATIC         = NO
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = NO
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = YES
+CASE_SENSE_NAMES       = YES
+HIDE_SCOPE_NAMES       = YES
+SHOW_INCLUDE_FILES     = YES
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = NO
+SORT_BRIEF_DOCS        = NO
+SORT_BY_SCOPE_NAME     = NO
+GENERATE_TODOLIST      = YES
+GENERATE_TESTLIST      = YES
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+MAX_INITIALIZER_LINES  = 25
+SHOW_USED_FILES        = NO
+SHOW_DIRECTORIES       = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+EXCLUDE_SYMLINKS       = NO
+EXAMPLE_RECURSIVE      = NO
+
+#---------------------------------------------------------------------------
+#Input related options
+#---------------------------------------------------------------------------
+INPUT             = @top_srcdir@/src/BLSURFPlugin/BLSURFPluginDC.py
+FILE_PATTERNS     = 
+IMAGE_PATH        = @srcdir@/images
+RECURSIVE         = NO
+EXAMPLE_PATH      =
+
+#---------------------------------------------------------------------------
+#HTML related options
+#---------------------------------------------------------------------------
+GENERATE_HTML     = YES
+HTML_OUTPUT       = blsurfpluginpy_doc
+HTML_HEADER       = @builddir@/static/header_py.html
+HTML_FOOTER       = @srcdir@/static/footer.html
+HTML_STYLESHEET   = @srcdir@/static/doxygen.css
+TOC_EXPAND        = YES
+DISABLE_INDEX     = NO
+GENERATE_TREEVIEW = NO
+
+#---------------------------------------------------------------------------
+#LaTeX related option
+#---------------------------------------------------------------------------
+GENERATE_LATEX    = NO
+
+#---------------------------------------------------------------------------
+#RTF related options
+#---------------------------------------------------------------------------
+GENERATE_RTF      = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool   
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = NO
+HIDE_UNDOC_RELATIONS   = NO
+HAVE_DOT               = NO
+CLASS_GRAPH            = NO
+COLLABORATION_GRAPH    = NO
+GROUP_GRAPHS           = NO
+UML_LOOK               = NO
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = NO
+INCLUDED_BY_GRAPH      = NO
+CALL_GRAPH             = NO
+GRAPHICAL_HIERARCHY    = NO
+DIRECTORY_GRAPH        = NO
+DOT_IMAGE_FORMAT       = jpg
+DOT_FONTNAME           = Arial
+DOT_PATH               = 
+DOTFILE_DIRS           = 
+MAX_DOT_GRAPH_WIDTH    = 1024
+MAX_DOT_GRAPH_HEIGHT   = 1200
+MAX_DOT_GRAPH_DEPTH    = 0
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = NO
+GENERATE_LEGEND        = NO
+DOT_CLEANUP            = YES
+
+#---------------------------------------------------------------------------
+#External reference options
+#---------------------------------------------------------------------------
+GENERATE_TAGFILE  = blsurfpluginpy_doc.tag
+SEARCHENGINE           = YES
\ No newline at end of file
diff --git a/doc/salome/gui/doxyfile.in b/doc/salome/gui/doxyfile.in
deleted file mode 100755 (executable)
index 6fc3e07..0000000
+++ /dev/null
@@ -1,63 +0,0 @@
-# Copyright (C) 2007-2011  CEA/DEN, EDF R&D
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
-#
-# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
-#
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-PROJECT_NAME      = "BLSURFPLUGIN Module Reference Manual v.@VERSION@"
-OUTPUT_DIRECTORY  = BLSURFPLUGIN
-CREATE_SUBDIRS   = NO
-OUTPUT_LANGUAGE   = English
-TAB_SIZE          = 5
-
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-QUIET             = NO
-WARNINGS          = YES
-
-#---------------------------------------------------------------------------
-#Input related options
-#---------------------------------------------------------------------------
-INPUT             = @srcdir@/input               
-FILE_PATTERNS     = *.doc
-IMAGE_PATH        = @srcdir@/images
-
-#---------------------------------------------------------------------------
-#HTML related options
-#---------------------------------------------------------------------------
-GENERATE_HTML     = YES
-HTML_OUTPUT       = .
-HTML_HEADER       = @srcdir@/static/header.html
-HTML_FOOTER       = @srcdir@/static/footer.html
-#HTML_STYLESHEET  = @srcdir@/static/doxygen.css
-TOC_EXPAND        = YES
-DISABLE_INDEX     = NO
-GENERATE_TREEVIEW = YES
-TREEVIEW_WIDTH    = 300
-
-#---------------------------------------------------------------------------
-#LaTeX related option
-#---------------------------------------------------------------------------
-GENERATE_LATEX    = NO
-
-#---------------------------------------------------------------------------
-#RTF related options
-#---------------------------------------------------------------------------
-GENERATE_RTF      = NO
diff --git a/doc/salome/gui/images/blsurf_attractors.png b/doc/salome/gui/images/blsurf_attractors.png
new file mode 100644 (file)
index 0000000..a0e0276
Binary files /dev/null and b/doc/salome/gui/images/blsurf_attractors.png differ
diff --git a/doc/salome/gui/images/blsurf_attractors2.png b/doc/salome/gui/images/blsurf_attractors2.png
new file mode 100644 (file)
index 0000000..09dc129
Binary files /dev/null and b/doc/salome/gui/images/blsurf_attractors2.png differ
diff --git a/doc/salome/gui/images/blsurf_const_size_near_shape.png b/doc/salome/gui/images/blsurf_const_size_near_shape.png
new file mode 100644 (file)
index 0000000..9e5ad6c
Binary files /dev/null and b/doc/salome/gui/images/blsurf_const_size_near_shape.png differ
diff --git a/doc/salome/gui/images/blsurf_const_size_near_shape2.png b/doc/salome/gui/images/blsurf_const_size_near_shape2.png
new file mode 100644 (file)
index 0000000..68620f3
Binary files /dev/null and b/doc/salome/gui/images/blsurf_const_size_near_shape2.png differ
diff --git a/doc/salome/gui/images/blsurf_parameters.png b/doc/salome/gui/images/blsurf_parameters.png
new file mode 100644 (file)
index 0000000..4da8a9e
Binary files /dev/null and b/doc/salome/gui/images/blsurf_parameters.png differ
diff --git a/doc/salome/gui/images/blsurf_parameters_advanced.png b/doc/salome/gui/images/blsurf_parameters_advanced.png
new file mode 100644 (file)
index 0000000..4fadb6b
Binary files /dev/null and b/doc/salome/gui/images/blsurf_parameters_advanced.png differ
diff --git a/doc/salome/gui/images/blsurf_parameters_enforced_vertices.png b/doc/salome/gui/images/blsurf_parameters_enforced_vertices.png
new file mode 100644 (file)
index 0000000..4a76b1a
Binary files /dev/null and b/doc/salome/gui/images/blsurf_parameters_enforced_vertices.png differ
diff --git a/doc/salome/gui/images/blsurf_parameters_sizemap.png b/doc/salome/gui/images/blsurf_parameters_sizemap.png
new file mode 100644 (file)
index 0000000..2b38197
Binary files /dev/null and b/doc/salome/gui/images/blsurf_parameters_sizemap.png differ
diff --git a/doc/salome/gui/images/blsurf_parameters_sizemap1.png b/doc/salome/gui/images/blsurf_parameters_sizemap1.png
new file mode 100644 (file)
index 0000000..4ae88c8
Binary files /dev/null and b/doc/salome/gui/images/blsurf_parameters_sizemap1.png differ
diff --git a/doc/salome/gui/images/blsurf_parameters_sizemap2.png b/doc/salome/gui/images/blsurf_parameters_sizemap2.png
new file mode 100644 (file)
index 0000000..e5e000d
Binary files /dev/null and b/doc/salome/gui/images/blsurf_parameters_sizemap2.png differ
diff --git a/doc/salome/gui/images/empty b/doc/salome/gui/images/empty
deleted file mode 100644 (file)
index e69de29..0000000