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

index dcdcd89..463b91e 100755 (executable)
@@ -35,7 +35,10 @@ DOC_PYTHONPATH=$(prefix)/bin/salome:$(prefix)/lib/python$(PYTHON_VERSION)/site-p
 DOC_LD_LIBRARY_PATH=$(prefix)lib/salome:${MED_ROOT_DIR}/lib/salome:${GEOM_ROOT_DIR}/lib/salome:${KERNEL_ROOT_DIR}/lib/salome
 DOC_SMESH_MeshersList=StdMeshers
 
-usr_docs: doxyfile_py doxyfile
+tmp/smeshBuilder.py: $(top_srcdir)/src/SMESH_SWIG/StdMeshersBuilder.py $(srcdir)/collect_mesh_methods.py
+       mkdir -p tmp && PYTHONPATH=$(DOC_PYTHONPATH):${PYTHONPATH} LD_LIBRARY_PATH=$(DOC_LD_LIBRARY_PATH):${LD_LIBRARY_PATH} SMESH_MeshersList=$(DOC_SMESH_MeshersList) $(PYTHON) $(srcdir)/collect_mesh_methods.py -o $@ StdMeshers
+
+usr_docs: doxyfile_py doxyfile tmp/smeshBuilder.py
        @$(DOXYGEN) doxyfile_py ;                                               \
        $(DOXYGEN) doxyfile
 
index a50e8e4..ab26414 100755 (executable)
 
 import sys
 
-def main(plugin, dummymeshhelp = True, output_file = "smesh.py"):
-    plugin_module = plugin + "DC"
+def main(plugin_name, dummymeshhelp = True, output_file = "smeshBuilder.py"):
+    plugin_module_name  = plugin_name + "Builder"
+    plugin_module       = "salome.%s.%s" % (plugin_name, plugin_module_name)
+    plugin_module_short = "SMESH_SWIG.%s" % (plugin_module_name)
     try:
-        mod = __import__(plugin_module)
+        exec( "from salome.smesh.smeshBuilder import *")
+        exec( "import %s" % plugin_module )
+        exec( "mod = %s" % plugin_module )
         methods = {}
         for attr in dir( mod ):
             if attr.startswith( '_' ): continue
@@ -66,7 +70,7 @@ def main(plugin, dummymeshhelp = True, output_file = "smesh.py"):
             output = []
             if dummymeshhelp:
                 output.append( "## @package smesh" )
-                output.append( "#  Documentation of the methods dynamically added by the " + plugin + " meshing plug-in to the Mesh class." )
+                output.append( "#  Documentation of the methods dynamically added by the " + plugin_name + " meshing plug-in to the Mesh class." )
                 output.append( "" )
                 pass
             output.append( "## This class allows defining and managing a mesh." )
@@ -76,7 +80,7 @@ def main(plugin, dummymeshhelp = True, output_file = "smesh.py"):
                 # This is supposed to be done when generating documentation for meshing plug-ins
                 output.append( "#  @note The documentation below does not provide complete description of class @b %Mesh" )
                 output.append( "#  from @b %smesh.py package. This documentation provides only information about" )
-                output.append( "#  the methods dynamically added to the %Mesh class by the " + plugin + " plugin" )
+                output.append( "#  the methods dynamically added to the %Mesh class by the " + plugin_name + " plugin" )
                 output.append( "#  For more details on the %Mesh class, please refer to the SALOME %Mesh module" )
                 output.append( "#  documentation." )
                 pass
@@ -104,7 +108,7 @@ def main(plugin, dummymeshhelp = True, output_file = "smesh.py"):
                 output.append( " #  @param algo_type type of algorithm to be created; allowed values are specified by classes implemented by plug-in (see below)" )
                 output.append( " #  @param geom_shape if defined, the subshape to be meshed (GEOM_Object)" )
                 output.append( " #  @return An instance of Mesh_Algorithm sub-class according to the specified @a algo_type, see " )
-                output.append( " #  %s" % ", ".join( [ "%s.%s" % ( plugin_module, algo.__name__ ) for algo in methods[ method ] ] ) )
+                output.append( " #  %s" % ", ".join( [ "%s.%s" % ( plugin_module_short, algo.__name__ ) for algo in methods[ method ] ] ) )
                 output.append( " def %s(algo_type, geom_shape=0):" % method )
                 output.append( "   pass" )
                 pass
index e9495d4..5450d6b 100755 (executable)
@@ -101,7 +101,8 @@ EXAMPLE_RECURSIVE      = NO
 #---------------------------------------------------------------------------
 INPUT             = @top_srcdir@/src/SMESH_SWIG/smeshBuilder.py \
                     @top_srcdir@/src/SMESH_SWIG/smesh_algorithm.py \
-                    @top_srcdir@/src/SMESH_SWIG/StdMeshersBuilder.py
+                    @top_srcdir@/src/SMESH_SWIG/StdMeshersBuilder.py \
+                    tmp/smeshBuilder.py
 FILE_PATTERNS     = 
 IMAGE_PATH        = @srcdir@/images
 RECURSIVE         = NO
index bf79aeb..468ca45 100644 (file)
@@ -56,19 +56,19 @@ for e in StdMeshers.QuadType._items: exec('%s = StdMeshers.%s'%(e,e))
 
 ## Defines segment 1D algorithm for edges discretization.
 #
-#  It can be created by calling smesh.Mesh.Segment(geom=0)
+#  It can be created by calling smeshBuilder.Mesh.Segment(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_Segment(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Segment"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = REGULAR
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -346,19 +346,19 @@ class StdMeshersBuilder_Segment(Mesh_Algorithm):
 
 ## Segment 1D algorithm for discretization of a set of adjacent edges as one edge.
 #
-#  It is created by calling smesh.Mesh.Segment(smesh.COMPOSITE,geom=0)
+#  It is created by calling smeshBuilder.Mesh.Segment(smesh.COMPOSITE,geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_CompositeSegment(StdMeshersBuilder_Segment):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Segment"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = COMPOSITE
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = False
     ## doc string of the method
@@ -377,15 +377,15 @@ class StdMeshersBuilder_CompositeSegment(StdMeshersBuilder_Segment):
 
 ## Defines a segment 1D algorithm for discretization of edges with Python function
 #
-#  It is created by calling smesh.Mesh.Segment(smesh.PYTHON,geom=0)
+#  It is created by calling smeshBuilder.Mesh.Segment(smesh.PYTHON,geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_Segment_Python(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Segment"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = PYTHON
     ## doc string of the method
@@ -422,19 +422,19 @@ class StdMeshersBuilder_Segment_Python(Mesh_Algorithm):
 
 ## Triangle MEFISTO 2D algorithm
 #
-#  It is created by calling smesh.Mesh.Triangle(smesh.MEFISTO,geom=0)
+#  It is created by calling smeshBuilder.Mesh.Triangle(smesh.MEFISTO,geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_Triangle_MEFISTO(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   = MEFISTO
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -475,19 +475,19 @@ class StdMeshersBuilder_Triangle_MEFISTO(Mesh_Algorithm):
 
 ## Defines a quadrangle 2D algorithm
 # 
-#  It is created by calling smesh.Mesh.Quadrangle(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Quadrangle(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_Quadrangle(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Quadrangle"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = QUADRANGLE
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -594,19 +594,19 @@ class StdMeshersBuilder_Quadrangle(Mesh_Algorithm):
 
 ## Defines a hexahedron 3D algorithm
 # 
-#  It is created by calling smesh.Mesh.Hexahedron(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Hexahedron(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_Hexahedron(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Hexahedron"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = Hexa
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -626,19 +626,19 @@ class StdMeshersBuilder_Hexahedron(Mesh_Algorithm):
 
 ## Defines a projection 1D algorithm
 #  
-#  It is created by calling smesh.Mesh.Projection1D(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Projection1D(geom=0)
 #
 #  @ingroup l3_algos_proj
 class StdMeshersBuilder_Projection1D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Projection1D"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Projection_1D"
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -683,19 +683,19 @@ class StdMeshersBuilder_Projection1D(Mesh_Algorithm):
 
 ## Defines a projection 2D algorithm
 #  
-#  It is created by calling smesh.Mesh.Projection2D(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Projection2D(geom=0)
 #
 #  @ingroup l3_algos_proj
 class StdMeshersBuilder_Projection2D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Projection2D"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Projection_2D"
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -746,15 +746,15 @@ class StdMeshersBuilder_Projection2D(Mesh_Algorithm):
 
 ## Defines a projection 1D-2D algorithm
 #  
-#  It is created by calling smesh.Mesh.Projection1D2D(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Projection1D2D(geom=0)
 #
 #  @ingroup l3_algos_proj
 class StdMeshersBuilder_Projection1D2D(StdMeshersBuilder_Projection2D):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Projection1D2D"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Projection_1D2D"
     ## doc string of the method
@@ -773,15 +773,15 @@ class StdMeshersBuilder_Projection1D2D(StdMeshersBuilder_Projection2D):
 
 ## Defines a projection 3D algorithm
 # 
-#  It is created by calling smesh.Mesh.Projection3D(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Projection3D(geom=0)
 #
 #  @ingroup l3_algos_proj
 class StdMeshersBuilder_Projection3D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Projection3D"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Projection_3D"
     ## doc string of the method
@@ -836,15 +836,15 @@ class StdMeshersBuilder_Projection3D(Mesh_Algorithm):
 ## Defines a Prism 3D algorithm, which is either "Extrusion 3D" or "Radial Prism"
 #  depending on geometry
 # 
-#  It is created by calling smesh.Mesh.Prism(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Prism(geom=0)
 #
 #  @ingroup l3_algos_3dextr
 class StdMeshersBuilder_Prism3D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Prism"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Prism_3D"
     ## doc string of the method
@@ -988,15 +988,15 @@ class StdMeshersBuilder_Prism3D(Mesh_Algorithm):
 ## Defines a Prism 3D algorithm, which is either "Extrusion 3D" or "Radial Prism"
 #  depending on geometry
 # 
-#  It is created by calling smesh.Mesh.Prism(geom=0)
+#  It is created by calling smeshBuilder.Mesh.Prism(geom=0)
 #
 #  @ingroup l3_algos_3dextr
 class StdMeshersBuilder_RadialPrism3D(StdMeshersBuilder_Prism3D):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Prism"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "RadialPrism_3D"
     ## doc string of the method
@@ -1020,15 +1020,15 @@ class StdMeshersBuilder_RadialPrism3D(StdMeshersBuilder_Prism3D):
 
 ## Defines a Radial Quadrangle 1D-2D algorithm
 # 
-#  It is created by calling smesh.Mesh.Quadrangle(smesh.RADIAL_QUAD,geom=0)
+#  It is created by calling smeshBuilder.Mesh.Quadrangle(smesh.RADIAL_QUAD,geom=0)
 #
 #  @ingroup l2_algos_radialq
 class StdMeshersBuilder_RadialQuadrangle1D2D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "Quadrangle"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = RADIAL_QUAD
     ## doc string of the method
@@ -1135,19 +1135,19 @@ class StdMeshersBuilder_RadialQuadrangle1D2D(Mesh_Algorithm):
 
 ## Defines a Use Existing Elements 1D algorithm
 #
-#  It is created by calling smesh.Mesh.UseExisting1DElements(geom=0)
+#  It is created by calling smeshBuilder.Mesh.UseExisting1DElements(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_UseExistingElements_1D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "UseExisting1DElements"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Import_1D"
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -1184,19 +1184,19 @@ class StdMeshersBuilder_UseExistingElements_1D(Mesh_Algorithm):
 
 ## Defines a Use Existing Elements 1D-2D algorithm
 #
-#  It is created by calling smesh.Mesh.UseExisting2DElements(geom=0)
+#  It is created by calling smeshBuilder.Mesh.UseExisting2DElements(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_UseExistingElements_1D2D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "UseExisting2DElements"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Import_1D2D"
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -1233,19 +1233,19 @@ class StdMeshersBuilder_UseExistingElements_1D2D(Mesh_Algorithm):
 
 ## Defines a Body Fitting 3D algorithm
 #
-#  It is created by calling smesh.Mesh.BodyFitted(geom=0)
+#  It is created by calling smeshBuilder.Mesh.BodyFitted(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_Cartesian_3D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "BodyFitted"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "Cartesian_3D"
     ## flag pointing either this algorithm should be used by default in dynamic method
-    #  of smesh.Mesh class
+    #  of smeshBuilder.Mesh class
     #  @internal
     isDefault  = True
     ## doc string of the method
@@ -1307,15 +1307,15 @@ class StdMeshersBuilder_Cartesian_3D(Mesh_Algorithm):
 ## Defines a stub 1D algorithm, which enables "manual" creation of nodes and
 #  segments usable by 2D algoritms
 #
-#  It is created by calling smesh.Mesh.UseExistingSegments(geom=0)
+#  It is created by calling smeshBuilder.Mesh.UseExistingSegments(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_UseExisting_1D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "UseExistingSegments"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "UseExisting_1D"
     ## doc string of the method
@@ -1335,15 +1335,15 @@ class StdMeshersBuilder_UseExisting_1D(Mesh_Algorithm):
 ## Defines a stub 2D algorithm, which enables "manual" creation of nodes and
 #  faces usable by 3D algoritms
 #
-#  It is created by calling smesh.Mesh.UseExistingFaces(geom=0)
+#  It is created by calling smeshBuilder.Mesh.UseExistingFaces(geom=0)
 #
 #  @ingroup l3_algos_basic
 class StdMeshersBuilder_UseExisting_2D(Mesh_Algorithm):
 
-    ## name of the dynamic method in smesh.Mesh class
+    ## name of the dynamic method in smeshBuilder.Mesh class
     #  @internal
     meshMethod = "UseExistingFaces"
-    ## type of algorithm used with helper function in smesh.Mesh class
+    ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
     algoType   = "UseExisting_2D"
     ## doc string of the method