ForkMaster/smesh
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/smesh.git synced 2025-02-06 16:14:18 +05:00
Code Issues Packages Projects Releases Wiki Activity

PR: doc correction for StdMeshers

Browse Source
This commit is contained in:
prascle 2013-03-20 15:11:59 +00:00
parent cb3d296cf2
commit 970a92d2c6
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/salome/gui/SMESH/doxyfile_py.in
View File

@ -101,7 +101,7 @@ EXAMPLE_RECURSIVE = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = @top_srcdir@/src/SMESH_SWIG/smeshBuilder.py \ INPUT = @top_srcdir@/src/SMESH_SWIG/smeshBuilder.py \
@top_srcdir@/src/SMESH_SWIG/smesh_algorithm.py \ @top_srcdir@/src/SMESH_SWIG/smesh_algorithm.py \
@top_srcdir@/src/SMESH_SWIG/StdMeshersDC.py @top_srcdir@/src/SMESH_SWIG/StdMeshersBuilder.py
FILE_PATTERNS = FILE_PATTERNS =
IMAGE_PATH = @srcdir@/images IMAGE_PATH = @srcdir@/images
RECURSIVE = NO RECURSIVE = NO

4
doc/salome/gui/SMESH/input/smeshpy_interface.doc
View File

@ -9,7 +9,7 @@ Documentation for SALOME %Mesh module Python API is available in two forms:
- <a href="smeshpy_doc/modules.html">Structured documentation</a>, where all methods and - <a href="smeshpy_doc/modules.html">Structured documentation</a>, where all methods and
classes are grouped by their functionality, like it is done in the GUI documentation classes are grouped by their functionality, like it is done in the GUI documentation
- <a href="smeshpy_doc/namespaces.html">Linear documentation</a> grouped only by classes, declared - <a href="smeshpy_doc/namespaces.html">Linear documentation</a> grouped only by classes, declared
in the \ref SMESH_SWIG.smeshBuilder "smeshBuilder" and \ref SMESH_SWIG.StdMeshersDC "StdMeshersDC" Python packages. in the \ref SMESH_SWIG.smeshBuilder "smeshBuilder" and \ref SMESH_SWIG.StdMeshersBuilder "StdMeshersBuilder" Python packages.
Class \ref SMESH_SWIG.smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle Class \ref SMESH_SWIG.smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
meshes. It can be used to create an empty mesh or to import mesh from the data file. meshes. It can be used to create an empty mesh or to import mesh from the data file.
@ -19,7 +19,7 @@ methods, described in \ref SMESH_SWIG.smeshBuilder.Mesh "class Mesh" documentati
Class \ref SMESH_SWIG.smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh. Class \ref SMESH_SWIG.smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh.
Please note that some algorithms, included in the standard SALOME Please note that some algorithms, included in the standard SALOME
distribution are always available. Python package \ref SMESH_SWIG.StdMeshersDC "StdMeshersDC" distribution are always available. Python package \ref SMESH_SWIG.StdMeshersBuilder "StdMeshersBuilder"
provides an interface for standard meshing algorithms included into provides an interface for standard meshing algorithms included into
the SALOME %Mesh module distribution, like: the SALOME %Mesh module distribution, like:
- REGULAR (1D) - REGULAR (1D)

4
src/SMESH_SWIG/smesh_algorithm.py
View File

@ -32,8 +32,8 @@ import SMESH
# #
# For each meshing algorithm, a python class inheriting from class %Mesh_Algorithm # For each meshing algorithm, a python class inheriting from class %Mesh_Algorithm
# should be defined. This descendant class should have two attributes defining the way # should be defined. This descendant class should have two attributes defining the way
# it is created by class Mesh (see e.g. class @ref StdMeshersDC.StdMeshersDC_Segment "StdMeshersDC_Segment" # it is created by class Mesh (see e.g. class @ref StdMeshersBuilder.StdMeshersBuilder_Segment "StdMeshersBuilder_Segment"
# in StdMeshersDC package): # in StdMeshersBuilder package):
# - @c meshMethod attribute defines name of method of class smesh.Mesh by calling which the # - @c meshMethod attribute defines name of method of class smesh.Mesh by calling which the
# python class of algorithm is created; this method is dynamically added to the smesh.Mesh class # python class of algorithm is created; this method is dynamically added to the smesh.Mesh class
# in runtime. For example, if in @c class MyPlugin_Algorithm this attribute is defined as # in runtime. For example, if in @c class MyPlugin_Algorithm this attribute is defined as