X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fmain.dox;h=33458d1189e05c1707b1467112baafb100d0d924;hb=cca842065fd2bb93bae7ed6c32a7de16b06f94d9;hp=7515c353c56ed5fc1095b7507504ad7b33ad4d89;hpb=f14439749926cca959747bb79fda10529520bd0b;p=modules%2Fkernel.git diff --git a/doc/salome/main.dox b/doc/salome/main.dox index 7515c353c..33458d118 100644 --- a/doc/salome/main.dox +++ b/doc/salome/main.dox @@ -1,82 +1,77 @@ -/*! \mainpage SALOME KERNEL Reference Documentation - \image html kernel_about_4.png +/*! - \section S1_main Introduction +\mainpage SALOME KERNEL Reference Documentation +\image html icon_about.png - Welcome to the %SALOME KERNEL documentation ! +Welcome to the %SALOME KERNEL documentation ! +Following your kind of usage of %SALOME, you will find some specific +introductory documentation, listed below. - Following your kind of usage of %SALOME, you will find some specific - introductory documentation, listed below. +\section S2_main End user - \section S2_main End user - -
    -
  1. - How to configure a %SALOME application - \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 +-# How to configure a %SALOME application\n + 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. -
    2. -
  2. - How to launch %SALOME in a %SALOME application - \n See \ref SALOME_Application. -
    3. -
  3. - How to use KERNEL services in Python scripts - \n The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services. -
    4. -
- - \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. - -
    -
  1. - How to install %SALOME - \n See \subpage INSTALL for general information on required configuration and +-# How to launch %SALOME\n + Use the python \subpage salome_command. +-# How to use KERNEL services in Python scripts\n + The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services. +-# How to use KERNEL services from a C++ context\n + The %SALOME KERNEL provides you with helper functions to + manipulate the %SALOME KERNEL services from a C++ programming + context. See \subpage KERNEL_Services_CppHelpers. + +\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. + +-# How to install %SALOME\n + See \subpage INSTALL for general information on required configuration and prerequisites, compilation procedure, setting environment principles. -
    2. -
  2. - How to configure a %SALOME application - \n See \ref SALOME_Application to define your own configuration of %SALOME and run it +-# How to configure a %SALOME application\n + 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. -
    3. -
- \section S4_main Module maintainer +\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. -
    -
  1. - Source code structuration and Unit Tests - \n See \subpage UnitTests for general information on code directories structure, +-# Source code structuration and Unit Tests\n + See \subpage UnitTests for general information on code directories structure, unit tests associated to the different kind of classes, and how to run the unit tests. -
    2. -
  2. - Some development utilities - \n See \subpage kernel_resources for information on basic utilities for C++ and Python +-# Some development utilities \n + See \subpage kernel_resources for information on basic utilities for C++ and Python development, like trace and debug, exceptions, singleton. -
    3. -
- \section S5_main SALOME programming model +\section S5_main SALOME programming model + +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. +- \subpage python_documentation : The package salome.kernel provides + logging tools, high-level functions to handle items in Salome study, and other utilities. + - You will find in the next pages informations about - specific points of %SALOME Kernel : +\section S6_main SALOME KERNEL module Developer Documentation - - \subpage dsc_page : DSC documentation page. - - \subpage salome_file_page : Salome_file documentation page. - - \subpage batch_page : BATCH documentation page. +To browse the \b SALOME KERNEL module Developer Documentation, follow the links below or use navigation menu at the top of the page: + */