From 8256b53d8df96a67f9169abc9b00e4b5a7bf6722 Mon Sep 17 00:00:00 2001 From: rnv Date: Tue, 11 Sep 2012 12:52:31 +0000 Subject: [PATCH] Implementation of the "0021670: EDF 2265 GUI: Update GUI documentation" issue. --- doc/salome/kernel_salome.dox | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/salome/kernel_salome.dox b/doc/salome/kernel_salome.dox index 20acf889c..d36db176a 100644 --- a/doc/salome/kernel_salome.dox +++ b/doc/salome/kernel_salome.dox @@ -3,6 +3,18 @@ \page kernel_salome Using salome.py module +The Python module salome.py provides a functionality to access main +SALOME features from the Python console (either embedded in GUI +desktop or external one). + +To use salome.py module, import it into the Python interpreter and +initialize it by calling \c salome_init() function: + +\code +import salome +salome.salome_init() +\endcode + The salome.py Python module provides a set of variables and functions allowing access to different elements of the current SALOME session. @@ -284,13 +296,4 @@ name_1 = salome.generateName() # name_1 is something like "Study682" name_1 = salome.generateName("Obj") # name_1 is something like "Obj32" \endcode -\li \b sg SWIG interface to the SALOME GUI - -This variable provides an access to some GUI functions. - -\b Note, that this variable is only available if you use salome.py -Python module within the GUI desktop (since SWIG library is linked directly to the GUI library). -See GUI documentation for more information. - - */ -- 2.39.2