From: prascle <prascle>
Date: Sun, 7 Apr 2013 11:43:32 +0000 (+0000)
Subject: PR: GSH3DPRLPlugin documentation correction
X-Git-Tag: V7_2_0~4
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=be86c94ecdd35c3cef2d8016e49ee6fd75fa7310;p=plugins%2Fghs3dprlplugin.git

PR: GSH3DPRLPlugin documentation correction
---

diff --git a/doc/salome/gui/GHS3DPRLPLUGIN/Makefile.am b/doc/salome/gui/GHS3DPRLPLUGIN/Makefile.am
index b6d0a75..d550c66 100755
--- a/doc/salome/gui/GHS3DPRLPLUGIN/Makefile.am
+++ b/doc/salome/gui/GHS3DPRLPLUGIN/Makefile.am
@@ -23,11 +23,14 @@ EXTRA_DIST += images input static/footer.html static/doxygen.css
 guidocdir = $(docdir)/gui/GHS3DPRLPLUGIN
 guidoc_DATA = images/head.png
 
-DOC_PYTHONPATH=$(prefix)/bin/salome:$(SMESH_ROOT_DIR)/bin/salome:$(SMESH_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(MED_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(GEOM_ROOT_DIR)/bin/salome:$(GEOM_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(KERNEL_ROOT_DIR)/bin/salome:$(KERNEL_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(OMNIORB_ROOT)/lib/python$(PYTHON_VERSION)/site-packages:$(OMNIORB_ROOT)/lib64/python$(PYTHON_VERSION)/site-packages
+DOC_PYTHONPATH=$(prefix)/bin/salome:$(prefix)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(SMESH_ROOT_DIR)/bin/salome:$(SMESH_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(MED_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(GEOM_ROOT_DIR)/bin/salome:$(GEOM_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(KERNEL_ROOT_DIR)/bin/salome:$(KERNEL_ROOT_DIR)/lib/python$(PYTHON_VERSION)/site-packages/salome:$(OMNIORB_ROOT)/lib/python$(PYTHON_VERSION)/site-packages:$(OMNIORB_ROOT)/lib64/python$(PYTHON_VERSION)/site-packages
 DOC_LD_LIBRARY_PATH=$(prefix)/lib/salome:${SMESH_ROOT_DIR}/lib/salome:${MED_ROOT_DIR}/lib/salome:${GEOM_ROOT_DIR}/lib/salome:${KERNEL_ROOT_DIR}/lib/salome
 DOC_SMESH_MeshersList=GHS3DPRLPlugin
 
-usr_docs: doxyfile_py doxyfile
+smeshBuilder.py: $(top_srcdir)/src/GHS3DPRLPlugin/GHS3DPRLPluginBuilder.py
+	@PYTHONPATH=$(DOC_PYTHONPATH):${PYTHONPATH} LD_LIBRARY_PATH=$(DOC_LD_LIBRARY_PATH):${LD_LIBRARY_PATH} SMESH_MeshersList=$(DOC_SMESH_MeshersList) $(PYTHON) $(SMESH_ROOT_DIR)/bin/salome/collect_mesh_methods.py -d -o $@ GHS3DPlugin
+
+usr_docs: doxyfile_py doxyfile smeshBuilder.py
 	@$(DOXYGEN) doxyfile_py ; \
 	$(DOXYGEN) doxyfile
 
diff --git a/doc/salome/gui/GHS3DPRLPLUGIN/doxyfile_py.in b/doc/salome/gui/GHS3DPRLPLUGIN/doxyfile_py.in
index 841b2f5..a4d42bd 100755
--- a/doc/salome/gui/GHS3DPRLPLUGIN/doxyfile_py.in
+++ b/doc/salome/gui/GHS3DPRLPLUGIN/doxyfile_py.in
@@ -97,7 +97,7 @@ EXAMPLE_RECURSIVE      = NO
 #Input related options
 #---------------------------------------------------------------------------
 INPUT             = @top_srcdir@/src/GHS3DPRLPlugin/GHS3DPRLPluginBuilder.py \
-                    @SMESH_ROOT_DIR@/lib/python@PYTHON_VERSION@/site-packages/salome/salome/smesh/smeshBuilder.py \
+                    smeshBuilder.py \
                     @SMESH_ROOT_DIR@/lib/python@PYTHON_VERSION@/site-packages/salome/salome/smesh/smesh_algorithm.py
 FILE_PATTERNS     = 
 IMAGE_PATH        = @srcdir@/images
diff --git a/doc/salome/gui/GHS3DPRLPLUGIN/input/ghs3dprlplugin_python_interface.doc b/doc/salome/gui/GHS3DPRLPLUGIN/input/ghs3dprlplugin_python_interface.doc
index 1f96f76..1b4e9b9 100644
--- a/doc/salome/gui/GHS3DPRLPLUGIN/input/ghs3dprlplugin_python_interface.doc
+++ b/doc/salome/gui/GHS3DPRLPLUGIN/input/ghs3dprlplugin_python_interface.doc
@@ -4,6 +4,6 @@
 
 Python package GHS3DPRLPlugin defines several classes, destined for creation of the 3D meshes.
 
-GHS3DPRL meshing plugin dynamically adds several methods to the  \ref SMESH_SWIG.smeshBuilder.Mesh "class Mesh" class to create meshing algorithms.
+GHS3DPRL meshing plugin dynamically adds several methods to the smeshBuilder.Mesh class to create meshing algorithms.
 
 */
diff --git a/src/GHS3DPRLPlugin/GHS3DPRLPluginBuilder.py b/src/GHS3DPRLPlugin/GHS3DPRLPluginBuilder.py
index 85680ce..245d6f5 100644
--- a/src/GHS3DPRLPlugin/GHS3DPRLPluginBuilder.py
+++ b/src/GHS3DPRLPlugin/GHS3DPRLPluginBuilder.py
@@ -51,16 +51,16 @@ GHS3DPRL = "GHS3DPRL_3D"
 
 ## Tetrahedron GHS3DPRL 3D algorithm
 #
-#  It is created by calling smesh.Mesh.Tetrahedron( smesh.GHS3DPRL, geom=0 )
+#  It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.GHS3DPRL, geom=0 )
 class GHS3DPRL_Algorithm(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Tetrahedron"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = GHS3DPRL
-    ## doc string of the method in smesh.Mesh class
+    ## doc string of the method in smeshBuilder.Mesh class
     #  @internal
     docHelper  = "Creates tetrahedron 3D algorithm for volumes"