From 970a92d2c64c3fdf7acee9049e39fed28a1798d8 Mon Sep 17 00:00:00 2001 From: prascle Date: Wed, 20 Mar 2013 15:11:59 +0000 Subject: [PATCH] PR: doc correction for StdMeshers --- doc/salome/gui/SMESH/doxyfile_py.in | 2 +- doc/salome/gui/SMESH/input/smeshpy_interface.doc | 4 ++-- src/SMESH_SWIG/smesh_algorithm.py | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/salome/gui/SMESH/doxyfile_py.in b/doc/salome/gui/SMESH/doxyfile_py.in index 6da1f2a08..33eb26206 100755 --- a/doc/salome/gui/SMESH/doxyfile_py.in +++ b/doc/salome/gui/SMESH/doxyfile_py.in @@ -101,7 +101,7 @@ EXAMPLE_RECURSIVE = NO #--------------------------------------------------------------------------- INPUT = @top_srcdir@/src/SMESH_SWIG/smeshBuilder.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 = IMAGE_PATH = @srcdir@/images RECURSIVE = NO diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index fcc2c0a44..2542a93e3 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -9,7 +9,7 @@ Documentation for SALOME %Mesh module Python API is available in two forms: - Structured documentation, where all methods and classes are grouped by their functionality, like it is done in the GUI documentation - Linear documentation 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 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. 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 the SALOME %Mesh module distribution, like: - REGULAR (1D) diff --git a/src/SMESH_SWIG/smesh_algorithm.py b/src/SMESH_SWIG/smesh_algorithm.py index 407f7817e..184d76ef0 100644 --- a/src/SMESH_SWIG/smesh_algorithm.py +++ b/src/SMESH_SWIG/smesh_algorithm.py @@ -32,8 +32,8 @@ import SMESH # # 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 -# it is created by class Mesh (see e.g. class @ref StdMeshersDC.StdMeshersDC_Segment "StdMeshersDC_Segment" -# in StdMeshersDC package): +# it is created by class Mesh (see e.g. class @ref StdMeshersBuilder.StdMeshersBuilder_Segment "StdMeshersBuilder_Segment" +# in StdMeshersBuilder package): # - @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 # in runtime. For example, if in @c class MyPlugin_Algorithm this attribute is defined as -- 2.39.2