X-Git-Url: http://git.salome-platform.org/gitweb/?p=modules%2Fsmesh.git;a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FSMESH%2Finput%2Fsmeshpy_interface.doc;h=bfede03bf77b60f2d5111a899123863a785f1bc1;hp=4fbf3d3b567efb134ab2a0e56f1a7694acbb446e;hb=15e95d02c3d43530b261b263c715baf41cae4d07;hpb=4735affc4fb7395f6a41b44438ae84f490ae8fe3 diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc index 4fbf3d3b5..bfede03bf 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -5,6 +5,25 @@ \n Python package smesh defines several classes, destined for easy and clear mesh creation and edition (see the \ref introduction_to_mesh_python_page "example"). -\n Also, please see \ref smeshDC "documentation for smesh.py" +\n Please draw your attention to the below notes before address to +the \ref smeshDC "documentation for smesh.py" -*/ \ No newline at end of file +\n 1. The main page of the \ref smeshDC "documentation for smesh.py" + contains a list of data structures and a list of functions, + provided by the package smesh.py. The first item in the data + structures list (\ref smeshDC::smeshDC "class smesh") also + represents documentation for methods of the package smesh.py itself. + +\n 2. Package smesh.py gives interface to create and manage + meshes. Please, use it to create an empty mesh or to import + it from data file. + +\n 3. Once you have created a mesh, you can manage it via its own + methods. See \ref smeshDC::Mesh "class Mesh" documentation for + them (it is also accessible by the second item "class Mesh" in the + data structures list). + +\n 4. Class Mesh allows to assign algorithms to a mesh. To add hypotheses, + please use interfaces, provided by the assigned algorithms. + +*/