./doc/salome/DevelopersGuide/DevelopersGuide.tex \
./doc/salome/DevelopersGuide/Makefile \
./doc/salome/tui/Makefile \
+ ./doc/salome/tui/KERNEL/doxyuser \
./idl/Makefile \
./resources/Makefile \
./resources/DEPRECATED/Plugin \
-
=================================================================
Installation instructions, up to date for 3.0 version
=================================================================
-You'll find here generic instructions for installing the SALOME2 platform.
+*html version of this document is produced with docutils*::
+
+ rst2html < doc.txt > doc.html
+
+*This document corresponds to SALOME2 3.1.0*
+
+.. contents::
+.. sectnum::
+-------------------------------------------+
| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
+-------------------------------------------+
+-------------------------------------------------------------------------------
+
+You'll find here generic instructions for installing the SALOME2 platform.
+
Summary
-------
$ source <salomeroot>/envSalome.sh
$ ./runSalome
+
+-------------------------------------------------------------------------------
+
++----------------------------------+------------------------------------------+
+| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
++----------------------------------+------------------------------------------+
+
+.. _`General KERNEL documentation`: ./index.html
+.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html
--- /dev/null
+=================================================================
+KERNEL Services for end user (Python interface)
+=================================================================
+
+*html version of this document is produced with docutils*::
+
+ rst2html < doc.txt > doc.html
+
+This document corresponds to SALOME2 3.2.0 (beta version)
+
+.. contents::
+.. sectnum::
+
++-------------------------------------------+
+| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
++-------------------------------------------+
+
+-------------------------------------------------------------------------------
+
+In a SALOME application, distributed components, servers and clients use
+the CORBA middleware for comunication. CORBA interfaces are defined via idl
+files. All the different CORBA interfaces are available for users in Python,
+see CORBA interfaces below.
+
+For some general purpose services, CORBA interfaces have been encapsulated
+in order to provide a simple interface (encapsulation is generally done in
+C++ classes, and a Python SWIG interface is also generated from C++, to
+ensure a consistent behavior between C++ modules and Python modules or user
+script).
+
+General purpose services
+========================
+
+Container and component instanciation
+-------------------------------------
+
+See LifeCycleCORBA_
+
+.. _LifeCycleCORBA: ./tui/KERNEL/classSALOME__LifeCycleCORBA.html
+
+CORBA Naming service access
+---------------------------
+
+See SALOME_NamingService_
+
+.. _SALOME_NamingService: ./tui/KERNEL/classSALOME__NamingService.html
+
+
+IDL Interfaces
+==============
+
++-----------------------------+-----------------------------------------------+
+| SALOME_Component_ | Container and Generic component interface, |
+| | File transfer service |
++-----------------------------+-----------------------------------------------+
+| SALOME_ContainerManager_ | |
++-----------------------------+-----------------------------------------------+
+| SALOMEDS_ | |
++-----------------------------+-----------------------------------------------+
+| SALOMEDS_Attributes_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_ModuleCatalog_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_RessourcesCatalog_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_Registry_ | |
++-----------------------------+-----------------------------------------------+
+| Logger_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_Comm_ | |
++-----------------------------+-----------------------------------------------+
+|SALOME_GenericObj_ | |
++-----------------------------+-----------------------------------------------+
+|SALOME_Exception_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_Session_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_MPIContainer_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_MPIObject_ | |
++-----------------------------+-----------------------------------------------+
+
+**Other idl for test purposes**
+nstest.idl
+SALOME_TestComponent.idl
+SALOME_TestModuleCatalog.idl
+SALOME_TestMPIComponent.idl
+TestNotif.idl
+
+.. _SALOME_Component: ./tui/KERNEL/SALOME__Component_8idl.html
+.. _SALOME_ContainerManager: ./tui/KERNEL/SALOME__ContainerManager_8idl.html
+.. _SALOMEDS: ./tui/KERNEL/SALOMEDS_8idl.html
+.. _SALOMEDS_Attributes: ./tui/KERNEL/SALOMEDS__Attributes_8idl.html
+.. _SALOME_ModuleCatalog: ./tui/KERNEL/SALOME__ModuleCatalog_8idl.html
+.. _SALOME_RessourcesCatalog: ./tui/KERNEL/SALOME__RessourcesCatalog_8idl.html
+.. _SALOME_Registry: ./tui/KERNEL/SALOME__Registry_8idl.html
+.. _Logger: ./tui/KERNEL/Logger_8idl.html
+.. _SALOME_Comm: ./tui/KERNEL/SALOME__Comm_8idl.html
+.. _SALOME_GenericObj: ./tui/KERNEL/SALOME__GenericObj_8idl.html
+.. _SALOME_Exception: ./tui/KERNEL/SALOME__Exception_8idl.html
+.. _SALOME_Session: ./tui/KERNEL/SALOME__Session_8idl.html
+.. _SALOME_MPIContainer: ./tui/KERNEL/SALOME__MPIContainer_8idl.html
+.. _SALOME_MPIObject: ./tui/KERNEL/SALOME__MPIObject_8idl.html
+
+
+-------------------------------------------------------------------------------
+
++----------------------------------+------------------------------------------+
+| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
++----------------------------------+------------------------------------------+
+
+.. _`General KERNEL documentation`: ./index.html
+.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html
UnitTests.html \
SALOME_Application.html \
INSTALL.html \
- kernel_resources.html
+ kernel_resources.html \
+ KERNEL_Services.html
endif
EXTRA_DIST=$(doc_DATA)
# Building html from restructured text files
-STYLESHEET=rst.css
+STYLESHEET=$(srcdir)/rst.css
RST2HTML=@RST2HTML@
RSTOPTS=--output-encoding=latin1 --stylesheet=$(STYLESHEET)
#RSTOPTS=--output-encoding=latin1
-
======================================================================
SALOME Application Concept. Configuration for one or more computers
======================================================================
This document corresponds to SALOME2 3.2. (alpha version)
+.. contents::
+.. sectnum::
+
+-------------------------------------------+
| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
+-------------------------------------------+
+-------------------------------------------------------------------------------
+
The following explains how to configure your own application with your list of
modules, how to define and run this application on one or more computers.
-.. contents::
-.. sectnum::
-
-
General principles
------------------
Then attach to the running SALOME_Session_Server process.
+
+-------------------------------------------------------------------------------
+
++----------------------------------+------------------------------------------+
+| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
++----------------------------------+------------------------------------------+
+
+.. _`General KERNEL documentation`: ./index.html
+.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html
-
=================================================================
Source code structuration and Unit Tests
=================================================================
-You will find here general information on code directories structure,
-unit tests associated to the different kind of classes, and how to run
-the unit tests.
+*html version of this document is produced with docutils*::
+
+ rst2html < doc.txt > doc.html
+
+*This document corresponds to SALOME2 3.2.0 (beta version)*
+
+.. contents::
+.. sectnum::
+-------------------------------------------+
| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
+-------------------------------------------+
-.. contents::
-.. sectnum::
+-------------------------------------------------------------------------------
+You will find here general information on code directories structure,
+unit tests associated to the different kind of classes, and how to run
+the unit tests.
SALOME KERNEL source code structuration
=======================================
+
+-------------------------------------------------------------------------------
+
++----------------------------------+------------------------------------------+
+| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
++----------------------------------+------------------------------------------+
+
+.. _`General KERNEL documentation`: ./index.html
+.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html
-
=================================================================
-General information, for developpers and users
+General information, for users, integrators and developers
=================================================================
-.. contents::
-.. sectnum::
-
-
*html version of this document is produced with docutils*::
rst2html < doc.txt > doc.html
-This document corresponds to SALOME2 3.1. (alpha version)
+*This document corresponds to SALOME2 3.2.0 (beta version)*
+
+.. contents::
+.. sectnum::
+-------------------------------------------+
| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
+-------------------------------------------+
-Developpers and users, which documentation ?
-============================================
+-------------------------------------------------------------------------------
+**Users, integrators and developers, which documentation ?**
Following your kind of usage of SALOME, you will find some specific
introductory documentation, listed below.
-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.
+End user
+========
+How to configure a SALOME application
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Application Integrator
-----------------------
+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.
-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.
+See SALOME_Application_ to define your own configuration of SALOME and run it
+on one or several computers. This is the recommended way of configuration.
-End user
---------
+.. _SALOME_Application: ./SALOME_Application.html
-The end user may have to configure his own SALOME applicatin by selection of a
-subset of availables SALOME modules. He also may want to install his
-application on several computers.
+How to launch SALOME in a SALOME application
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Documentation for developpers and module maintainers
-====================================================
+See SALOME_Application_.
-Source code structuration and Unit Tests
-----------------------------------------
+How to use KERNEL services in Python scripts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-See UnitTests_ for general information on code directories structure,
-unit tests associated to the different kind of classes, and how to run
-the unit tests.
+The SALOME KERNEL offers offers a list of services available in Python.
-.. _UnitTests: ./UnitTests.html
+See KERNEL_Services_.
+
+.. _KERNEL_Services: ./KERNEL_Services.html
+
+Application Integrator
+======================
-Documentation for application integrators and adminstrators
-===========================================================
+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
----------------------
+~~~~~~~~~~~~~~~~~~~~~
See INSTALL_ for general information on required configuration and
prerequisites, compilation procedure, setting environment principles.
.. _INSTALL: ./INSTALL.html
-How to run SALOME on one or more computers, SALOME Application concept
-----------------------------------------------------------------------
+How to configure a SALOME application
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
See SALOME_Application_ to define your own configuration of SALOME and run it
on one or several computers. This is the recommended way of configuration.
.. _SALOME_Application: ./SALOME_Application.html
-End User documentation
-======================
+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.
+
+Source code structuration and Unit Tests
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+See UnitTests_ for general information on code directories structure,
+unit tests associated to the different kind of classes, and how to run
+the unit tests.
+
+.. _UnitTests: ./UnitTests.html
+
+Some development utilities
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+See kernel_resources_ for information on basic utilities for C++ and Python
+development, like trace and debug, exceptions, singleton.
+
+.. _kernel_resources: ./kernel_resources.html
-link to end user documentation.
+-------------------------------------------------------------------------------
++----------------------------------+------------------------------------------+
+| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
++----------------------------------+------------------------------------------+
+.. _`General KERNEL documentation`: ./index.html
+.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html
rst2html doc.txt > doc.html
+*This document corresponds to SALOME2 3.2.0 (beta version)*
+
:Authors:
Antoine Yessayan,
Paul Rascle
| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
+-------------------------------------------+
+-------------------------------------------------------------------------------
+
**Abstract**
This document describes the development environment for
.. contents::
.. sectnum::
+-------------------------------------------------------------------------------
+
Trace and debug Utilities
=========================
* the ``Nettoyage()`` C function using ``atexit()`` C function
is embedded in a static single object ``ATEXIT_()``.
+
+
+-------------------------------------------------------------------------------
+
++----------------------------------+------------------------------------------+
+| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
++----------------------------------+------------------------------------------+
+
+.. _`General KERNEL documentation`: ./index.html
+.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html
H1.title
{
- FONT-SIZE: 200%;
+ FONT-SIZE: 150%;
COLOR: #00008B;
text-align: center
}
H1
{
- FONT-SIZE: 150%;
+ FONT-SIZE: 125%;
}
H2
{
- FONT-SIZE: 125%;
+ FONT-SIZE: 108%;
}
h2.subtitle {
text-align: center }
H3
{
- FONT-SIZE: 108%;
+ FONT-SIZE: 100%;
}
BODY
{
--- /dev/null
+# Doxyfile 1.3-rc1
+
+#---------------------------------------------------------------------------
+# General configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "SALOME v.@VERSION@"
+PROJECT_NUMBER = id#1.1
+OUTPUT_DIRECTORY = ../
+OUTPUT_LANGUAGE = English
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = NO
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = NO
+ALWAYS_DETAILED_SEC = YES
+INLINE_INHERITED_MEMB = YES
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+INTERNAL_DOCS = YES
+CASE_SENSE_NAMES = YES
+SHORT_NAMES = NO
+HIDE_SCOPE_NAMES = NO
+VERBATIM_HEADERS = YES
+SHOW_INCLUDE_FILES = YES
+JAVADOC_AUTOBRIEF = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = NO
+INHERIT_DOCS = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = NO
+SORT_BY_SCOPE_NAME = YES
+DISTRIBUTE_GROUP_DOC = NO
+TAB_SIZE = 5
+GENERATE_TODOLIST = NO
+GENERATE_TESTLIST = NO
+GENERATE_BUGLIST = NO
+GENERATE_DEPRECATEDLIST= NO
+ALIASES =
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 25
+OPTIMIZE_OUTPUT_FOR_C = YES
+OPTIMIZE_OUTPUT_JAVA = NO
+SHOW_USED_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE = log.txt
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = \
+ @top_builddir@/bin/salome \
+ @top_srcdir@/idl \
+ @top_srcdir@/src/Container \
+ @top_srcdir@/src/LifeCycleCORBA \
+ @top_srcdir@/src/NamingService \
+ @top_srcdir@/src/Notification \
+ @top_builddir@/src/Utils
+FILE_PATTERNS = *.idl *.hxx *.cxx python_extension_must_be_here
+RECURSIVE = YES
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS =
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH = sources/
+INPUT_FILTER =
+FILTER_SOURCE_FILES = YES
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = KERNEL
+HTML_FILE_EXTENSION = .html
+HTML_HEADER = sources/myheader.html
+HTML_FOOTER = sources/footer.html
+HTML_STYLESHEET = sources/doxygen.css
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+BINARY_TOC = YES
+TOC_EXPAND = YES
+DISABLE_INDEX = YES
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_SCHEMA =
+XML_DTD =
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = NO
+#---------------------------------------------------------------------------
+# Configuration::addtions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+HIDE_UNDOC_RELATIONS = NO
+HAVE_DOT = YES
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = NO
+TEMPLATE_RELATIONS = YES
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DOT_IMAGE_FORMAT = jpg
+DOT_PATH =
+DOTFILE_DIRS =
+MAX_DOT_GRAPH_WIDTH = 1024
+MAX_DOT_GRAPH_HEIGHT = 1200
+GENERATE_LEGEND = NO
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::addtions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
--- /dev/null
+H1 {
+ text-align: center;
+}
+
+CAPTION {
+ font-weight: bold
+}
+
+/* Link in the top navbar */
+A.qindex {}
+
+A.qindexRef {}
+
+/* Link to any cross-referenced Doxygen element */
+A.el {
+ text-decoration: none;
+ font-weight: bold
+}
+
+A.elRef {
+ font-weight: bold
+}
+
+/* Link to any cross-referenced Doxygen element inside a code section
+ (ex: header)
+*/
+A.code {
+ text-decoration: none;
+ font-weight: normal;
+ color: #4444ee
+}
+
+A.codeRef {
+ font-weight: normal;
+ color: #4444ee
+}
+
+A:hover {
+ text-decoration: none;
+ background-color: lightblue
+}
+
+DL.el {
+ margin-left: -1cm
+}
+
+/* A code fragment (ex: header) */
+DIV.fragment {
+ width: 100%;
+ border: none;
+ background-color: #CCCCCC
+}
+
+/* In the alpha list (coumpound index), style of an alphabetical index letter */
+DIV.ah {
+ background-color: #CCCCCC;
+ font-weight: bold;
+ color: #ffffff;
+ margin-bottom: 3px;
+ margin-top: 3px
+}
+
+/* Method name (+ type) */
+TD.md {
+ background-color: lightblue;
+ font-weight: bold;
+}
+
+/* Method parameter (some of them) */
+TD.mdname1 {
+ background-color: lightblue;
+ font-weight: bold; color: #602020;
+}
+
+/* Method parameter (some of them) */
+TD.mdname {
+ background-color: lightblue;
+ font-weight: bold;
+ color: #602020;
+ width: 600px;
+}
+
+/* Separator between methods group (usually empty, seems not supported by IE) */
+DIV.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ margin-bottom: 6px;
+ font-weight: bold
+}
+
+DIV.groupText {
+ margin-left: 16px;
+ font-style: italic;
+ font-size: smaller
+}
+
+BODY {
+ background: url(sources/bg_salome.gif)
+}
+
+div.tabs {
+ text-align: justify;
+ font-weight: bold;
+ color: #FFFFFF;
+}
+
+DIV.div-footer {
+ margin-left: 1em;
+ margin-right: 1em;
+ margin-bottom: 0.2em;
+ text-align: right;
+ font-size: 9pt;
+}
+
+/* In File List, Coumpound List, etc, 1st column of the index */
+TD.indexkey {
+ background-color: #CCCCCC;
+ font-weight: bold;
+ padding-right : 10px;
+ padding-top : 2px;
+ padding-left : 10px;
+ padding-bottom : 2px;
+ margin-left : 0px;
+ margin-right : 0px;
+ margin-top : 2px;
+ margin-bottom : 2px
+}
+
+/* In File List, Coumpound List, etc, 2nd column of the index */
+TD.indexvalue {
+ background-color: #CCCCCC;
+ font-style: italic;
+ padding-right : 10px;
+ padding-top : 2px;
+ padding-left : 10px;
+ padding-bottom : 2px;
+ margin-left : 0px;
+ margin-right : 0px;
+ margin-top : 2px;
+ margin-bottom : 2px
+}
+
+span.keyword { color: #008000 }
+span.keywordtype { color: #604020 }
+span.keywordflow { color: #e08000 }
+span.comment { color: #800000 }
+span.preprocessor { color: #806020 }
+span.stringliteral { color: #002080 }
+span.charliteral { color: #008080 }
--- /dev/null
+</DIV>
+
+
+<DIV class="div-footer">
+</tr>
+<hr>
+<table cellspacing="2" align="center" bgcolor="#808080" frame="void">
+ <tbody align="center" valign="center" bgcolor="#D3D3D3">
+ <tr>
+ <td> <a href="../../index.html">General KERNEL Documentation</a> </td>
+ <td> <a href="../../KERNEL_Services.html">End User KERNEL Services</a> </td>
+ <td> <a href="main.html">End User KERNEL Doxygen Documentation</a> </td>
+ </tr>
+ </tbody>
+</table>
+<br>
+Generated on $datetime for $projectname by <A href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></A> $doxygenversion</DIV>
+</BODY>
+</HTML>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body>
-
-<center><table WIDTH="96%" >
-<tr>
-<td><a href="http://www.opencascade.com"><img src="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>
-
-
-<td>
-<div align=right><a href="http://www.opencascade.org/SALOME/"><img src="sources/application.gif" BORDER=0 height=46 width=108></a></div>
-</td>
-</tr>
-</table></center>
-
-
+<table cellspacing="2" align="center" bgcolor="#808080" frame="void">
+ <tbody align="center" valign="center" bgcolor="#D3D3D3">
+ <tr>
+ <td> <a href="../../index.html">General KERNEL Documentation</a> </td>
+ <td> <a href="../../KERNEL_Services.html">End User KERNEL Services</a> </td>
+ <td> <a href="main.html">End User KERNEL Doxygen Documentation</a> </td>
+ </tr>
+ </tbody>
+</table>
+<br>
+<hr>
</body>
</html>
-H1 { text-align: center; }
-CAPTION { font-weight: bold }
+H1 {
+ text-align: center;
+}
+
+CAPTION {
+ font-weight: bold
+}
+
+/* Link in the top navbar */
A.qindex {}
+
A.qindexRef {}
-A.el { text-decoration: none; font-weight: bold }
-A.elRef { font-weight: bold }
-A.code { text-decoration: none; font-weight: normal; color: #4444ee }
-A.codeRef { font-weight: normal; color: #4444ee }
-A:hover { text-decoration: none; background-color: lightblue }
-DL.el { margin-left: -1cm }
-DIV.fragment { width: 100%; border: none; background-color: #CCCCCC }
-DIV.ah { background-color: #CCCCCC; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
-TD.md { background-color: lightblue; font-weight: bold; }
-TD.mdname1 { background-color: lightblue; font-weight: bold; color: #602020; }
-TD.mdname { background-color: lightblue; font-weight: bold; color: #602020; width: 600px; }
-DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }
-DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }
-BODY { background: url(sources/bg_salome.gif) }
+
+/* Link to any cross-referenced Doxygen element */
+A.el {
+ text-decoration: none;
+ font-weight: bold
+}
+
+A.elRef {
+ font-weight: bold
+}
+
+/* Link to any cross-referenced Doxygen element inside a code section
+ (ex: header)
+*/
+A.code {
+ text-decoration: none;
+ font-weight: normal;
+ color: #4444ee
+}
+
+A.codeRef {
+ font-weight: normal;
+ color: #4444ee
+}
+
+A:hover {
+ text-decoration: none;
+ background-color: lightblue
+}
+
+DL.el {
+ margin-left: -1cm
+}
+
+/* A code fragment (ex: header) */
+DIV.fragment {
+ width: 100%;
+ border: none;
+ background-color: #CCCCCC
+}
+
+/* In the alpha list (coumpound index), style of an alphabetical index letter */
+DIV.ah {
+ background-color: #CCCCCC;
+ font-weight: bold;
+ color: #ffffff;
+ margin-bottom: 3px;
+ margin-top: 3px
+}
+
+/* Method name (+ type) */
+TD.md {
+ background-color: lightblue;
+ font-weight: bold;
+}
+
+/* Method parameter (some of them) */
+TD.mdname1 {
+ background-color: lightblue;
+ font-weight: bold; color: #602020;
+}
+
+/* Method parameter (some of them) */
+TD.mdname {
+ background-color: lightblue;
+ font-weight: bold;
+ color: #602020;
+ width: 600px;
+}
+
+/* Separator between methods group (usually empty, seems not supported by IE) */
+DIV.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ margin-bottom: 6px;
+ font-weight: bold
+}
+
+DIV.groupText {
+ margin-left: 16px;
+ font-style: italic;
+ font-size: smaller
+}
+
+BODY {
+ background: url(sources/bg_salome.gif)
+}
+
+div.tabs {
+ text-align: justify;
+ font-weight: bold;
+ color: #FFFFFF;
+}
+
+DIV.div-footer {
+ margin-left: 1em;
+ margin-right: 1em;
+ margin-bottom: 0.2em;
+ text-align: right;
+ font-size: 9pt;
+}
+
+/* In File List, Coumpound List, etc, 1st column of the index */
TD.indexkey {
background-color: #CCCCCC;
font-weight: bold;
margin-top : 2px;
margin-bottom : 2px
}
+
+/* In File List, Coumpound List, etc, 2nd column of the index */
TD.indexvalue {
background-color: #CCCCCC;
font-style: italic;
margin-top : 2px;
margin-bottom : 2px
}
+
span.keyword { color: #008000 }
span.keywordtype { color: #604020 }
span.keywordflow { color: #e08000 }
userdoc:
cp -fr $(srcdir)/KERNEL ./INPUT; \
- cd INPUT; \
- sed 's|../../../share/salome|@top_srcdir@|' ./doxyfile > ./doxyfile1; \
- sed 's|../../../build/salome|@top_builddir@|' ./doxyfile1 > ./doxyfile2; \
- mv -f doxyfile2 doxyfile1; \
+ cp -f $(top_builddir)/doc/salome/tui/KERNEL/doxyuser ./INPUT; \
+ cd ./INPUT; \
+ pwd; ls;\
echo "DOXYGEN SUPPORT PYTHON - $(DOXYGEN_WITH_PYTHON)"; \
if( test "x$(DOXYGEN_WITH_PYTHON)" = "xyes"); then \
- sed 's|python_extension_must_be_here|*.py|' ./doxyfile1 > ./doxyfile2; \
- mv -f doxyfile2 doxyfile1; \
- $(DOXYGEN) -u ./doxyfile1; \
+ sed 's|python_extension_must_be_here|*.py|' ./doxyuser > ./doxyuser1; \
+ $(DOXYGEN) -u ./doxyuser1; \
else \
- sed 's|python_extension_must_be_here||' ./doxyfile1 > ./doxyfile2; \
- mv -f doxyfile2 doxyfile1; \
+ sed 's|python_extension_must_be_here||' ./doxyuser > ./doxyuser1; \
fi; \
+ echo "DOXYGEN SUPPORT STL - $(DOXYGEN_WITH_STL)"; \
if( test "x$(DOXYGEN_WITH_STL)" = "xyes"); then \
- sed -e 's|BUILTIN_STL_SUPPORT = NO|BUILTIN_STL_SUPPORT = YES|' ./doxyfile1 > ./doxyfile2; \
- mv -f doxyfile2 doxyfile1; \
+ sed -e 's|BUILTIN_STL_SUPPORT = NO|BUILTIN_STL_SUPPORT = YES|' ./doxyuser1 > ./doxyuser2; \
+ mv -f doxyuser2 doxyuser1; \
fi; \
- mv -f doxyfile1 doxyfile; \
- $(DOXYGEN) ./doxyfile; \
+ $(DOXYGEN) ./doxyuser1; \
cd ..;
$(INSTALL) -d $(docdir)/tui/KERNEL;
cp -fr KERNEL $(docdir)/tui
-
=================================================================
User's guide, for developpers and users
=================================================================
+*html version of this document is produced with docutils*::
+
+ rst2html < doc.txt > doc.html
+
+*This document corresponds to SALOME2 3.2.0 (beta version)*
+
.. contents::
.. sectnum::
++-------------------------------------------+
+| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
++-------------------------------------------+
+
+-------------------------------------------------------------------------------
+
This guide provides you with some basic concepts for developing and
using the SALOME platform. You will find some information on the
general technical architecture ...
.. _INSTALL: ./INSTALL.html
+
+-------------------------------------------------------------------------------
+
++----------------------------------+------------------------------------------+
+| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
++----------------------------------+------------------------------------------+
+
+.. _`General KERNEL documentation`: ./index.html
+.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html
