Salome HOME
Restore documentation of methods dynamically added by plug-ins to the Mesh class...
authorvsr <vsr@opencascade.com>
Fri, 5 Apr 2013 09:42:24 +0000 (09:42 +0000)
committervsr <vsr@opencascade.com>
Fri, 5 Apr 2013 09:42:24 +0000 (09:42 +0000)
doc/salome/gui/BLSURFPLUGIN/Makefile.am
doc/salome/gui/BLSURFPLUGIN/doxyfile_py.in
src/BLSURFPlugin/BLSURFPluginBuilder.py

index f0cb7ec0992d68761f436ed759488a008a025542..5721bd7cbf418486a7b7e8ac5cce581291fa7328 100644 (file)
@@ -28,11 +28,14 @@ EXTRA_DIST += images input static/footer.html static/doxygen.css
 guidocdir = $(docdir)/gui/BLSURFPLUGIN
 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=BLSURFPlugin
 
-usr_docs: doxyfile_py doxyfile
+smeshBuilder.py: $(top_srcdir)/src/BLSURFPlugin/BLSURFPluginBuilder.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 $@ BLSURFPlugin
+
+usr_docs: doxyfile_py doxyfile smeshBuilder.py
        @$(DOXYGEN) doxyfile_py ; \
        $(DOXYGEN) doxyfile
 
index 4dad6590f1c83d953a9445bb7c0c4811815e7efa..463265f25a6b79f3a130a4ea1eb40cc71fd9753c 100755 (executable)
@@ -97,7 +97,7 @@ EXAMPLE_RECURSIVE      = NO
 #Input related options
 #---------------------------------------------------------------------------
 INPUT             = @top_srcdir@/src/BLSURFPlugin/BLSURFPluginBuilder.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
index 4c2316e74e37c98098285f8020e3705382447bfe..dd149b888db6e6fe9064f21d88ac949bbb131927 100644 (file)
@@ -54,14 +54,14 @@ BLSURF = "BLSURF"
 
 ## BLSurf 2D algorithm.
 #
-#  It can be created by calling smesh.Mesh.Triangle(smesh.BLSURF,geom=0)
+#  It can be created by calling smeshBuilder.Mesh.Triangle(smesh.BLSURF,geom=0)
 #
 class BLSURF_Algorithm(Mesh_Algorithm):
 
-  ## name of the dynamic method in smesh.Mesh class
+  ## name of the dynamic method in smeshBuilder.Mesh class
   #  @internal
   meshMethod = "Triangle"
-  ## type of algorithm used with helper function in smesh.Mesh class
+  ## type of algorithm used with helper function in smeshBuilder.Mesh class
   #  @internal
   algoType   = BLSURF
   ## doc string of the method