Salome HOME
#19007 [CEA][Windows] SALOME non regression tests on Windows: fix KERNEL_SALOME_COMMA...
[modules/kernel.git] / doc / salome / main.dox
index eea5b33e946dc0658174f982db18773f453d61f3..33458d1189e05c1707b1467112baafb100d0d924 100644 (file)
@@ -4,20 +4,19 @@
 \image html icon_about.png
 
 Welcome to the %SALOME KERNEL documentation !
-Following your kind of usage of %SALOME, you will find some specific 
+Following your kind of usage of %SALOME, you will find some specific
 introductory documentation, listed below.
 
 \section S2_main End user
 
 -# <b>How to configure a %SALOME application</b>\n
-    The end user may have to configure his own %SALOME application by selection of a
-    subset of availables %SALOME modules. He also may want to install his
-    application on several computers. 
-    See \subpage SALOME_Application to define your own configuration of %SALOME and run it  
+    The end user may have to configure his own %SALOME application by selecting a
+    subset of available %SALOME modules. He may also want to install his
+    application on several computers.
+    See \subpage SALOME_Application to define your own configuration of %SALOME and run it
     on one or several computers. This is the recommended way of configuration.
--# <b>How to launch %SALOME</b>:
-    - In a %SALOME application, see \ref SALOME_Application.
-    - Using \c runSalome script, see \subpage running_salome_page
+-# <b>How to launch %SALOME</b>\n
+    Use the python \subpage salome_command.
 -# <b>How to use KERNEL services in Python scripts</b>\n
     The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
 -# <b>How to use KERNEL services from a C++ context</b>\n
@@ -27,23 +26,23 @@ introductory documentation, listed below.
 
 \section S3_main Application Integrator
 
-    Applications integrators are in charge of configuration and installation of
-    specific %SALOME applications over a local network. Application Integrators 
-    built %SALOME modules binaries from sources tarballs.
+Applications integrators are in charge of configuration and installation of
+specific %SALOME applications over a local network. Application Integrators
+built %SALOME modules binaries from sources tarballs.
 
 -# <b>How to install %SALOME</b>\n
-    See \subpage INSTALL for general information on required configuration and 
+    See \subpage INSTALL for general information on required configuration and
     prerequisites, compilation procedure, setting environment principles.
 -# <b>How to configure a %SALOME application</b>\n
-    See \ref SALOME_Application to define your own configuration of %SALOME and run it  
+    See \ref SALOME_Application to define your own configuration of %SALOME and run it
     on one or several computers. This is the recommended way of configuration.
 
 \section S4_main Module maintainer
 
-    Module maintainers are in charge of the development and debug of the %SALOME
-    modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
-    in separate branches for developments and debug. All official or development
-    releases are identified by a CVS tag.
+Module maintainers are in charge of the development and debug of the %SALOME
+modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
+in separate branches for developments and debug. All official or development
+releases are identified by a CVS tag.
 
 -# <b>Source code structuration and Unit Tests</b>\n
     See \subpage UnitTests for general information on code directories structure,
@@ -55,15 +54,24 @@ introductory documentation, listed below.
 
 \section S5_main SALOME programming model
 
-    You will find in the next pages informations about
-    specific points of %SALOME Kernel :
+You will find in the next pages information about
+specific points of %SALOME Kernel :
 
-    - \subpage kernel_salome 
-    - \subpage dsc_page : DSC documentation page.
-    - \subpage salome_file_page : Salome_file documentation page.
-    - <a class="el" href="../../tui/KERNEL/docutils/index.html" target="_new">
-      Documentation of the KERNEL python package</a> : The package salome.kernel provides
-      logging tools, high-level functions to handle items in Salome study, and other utilities.
+- \subpage kernel_salome
+- \subpage dsc_page : DSC documentation page.
+- \subpage salome_file_page : Salome_file documentation page.
+- \subpage python_documentation : The package salome.kernel provides
+  logging tools, high-level functions to handle items in Salome study, and other utilities.
+
+
+\section S6_main SALOME KERNEL module Developer Documentation
+
+To browse the \b SALOME KERNEL module Developer Documentation, follow the links below or use navigation menu at the top of the page:
+<ul>
+<li> <a href="namespaces.html">Namespaces</a> - list of KERNEL namespaces and scripts.</li>
+<li> <a href="annotated.html">Data Structures</a> - list of all data structures and classes with brief descriptions.</li>
+<li> <a href="files.html">Files</a> - list of all files with brief descriptions.</li>
+</ul>
 
 */