From 8293bab3ba9d39b1b5ca6e87da911018e1c5c950 Mon Sep 17 00:00:00 2001 From: prascle Date: Wed, 24 May 2006 12:36:08 +0000 Subject: [PATCH] PR: doc improvement (in progress) --- configure.ac | 1 + doc/INSTALL.txt | 23 +- doc/KERNEL_Services.txt | 113 ++++++++++ doc/Makefile.am | 5 +- doc/SALOME_Application.txt | 19 +- doc/UnitTests.txt | 27 ++- doc/index.txt | 106 +++++---- doc/kernel_resources.txt | 16 ++ doc/rst.css | 8 +- doc/salome/tui/KERNEL/doxyuser.in | 202 ++++++++++++++++++ doc/salome/tui/KERNEL/sources/doxygen.css | 149 +++++++++++++ doc/salome/tui/KERNEL/sources/footer.html | 19 ++ .../tui/KERNEL/sources/html_comments.gif | Bin 0 -> 156 bytes doc/salome/tui/KERNEL/sources/myheader.html | 24 +-- .../tui/KERNEL/sources/static/doxygen.css | 132 ++++++++++-- doc/salome/tui/Makefile.am | 23 +- doc/userguide.txt | 22 +- 17 files changed, 786 insertions(+), 103 deletions(-) create mode 100644 doc/KERNEL_Services.txt create mode 100644 doc/salome/tui/KERNEL/doxyuser.in create mode 100755 doc/salome/tui/KERNEL/sources/doxygen.css create mode 100755 doc/salome/tui/KERNEL/sources/footer.html create mode 100755 doc/salome/tui/KERNEL/sources/html_comments.gif diff --git a/configure.ac b/configure.ac index 2ef5fa0c0..0ba3f492b 100644 --- a/configure.ac +++ b/configure.ac @@ -496,6 +496,7 @@ AC_OUTPUT([ \ ./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 \ diff --git a/doc/INSTALL.txt b/doc/INSTALL.txt index dddcadb43..109731795 100644 --- a/doc/INSTALL.txt +++ b/doc/INSTALL.txt @@ -1,14 +1,24 @@ - ================================================================= 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 ------- @@ -378,3 +388,12 @@ For convenience or customization, we suggest the following organisation: $ source /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 diff --git a/doc/KERNEL_Services.txt b/doc/KERNEL_Services.txt new file mode 100644 index 000000000..371c1df3e --- /dev/null +++ b/doc/KERNEL_Services.txt @@ -0,0 +1,113 @@ +================================================================= +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 diff --git a/doc/Makefile.am b/doc/Makefile.am index 4a75f2797..a9cc90f42 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -17,14 +17,15 @@ if RST2HTML_IS_OK 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 diff --git a/doc/SALOME_Application.txt b/doc/SALOME_Application.txt index 48e19a0bd..4034df5e4 100644 --- a/doc/SALOME_Application.txt +++ b/doc/SALOME_Application.txt @@ -1,4 +1,3 @@ - ====================================================================== SALOME Application Concept. Configuration for one or more computers ====================================================================== @@ -9,17 +8,18 @@ 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 ------------------ @@ -335,3 +335,12 @@ launch a SALOME session with gui, then, on another terminal:: 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 diff --git a/doc/UnitTests.txt b/doc/UnitTests.txt index bb03dd8e3..fbaaea0f6 100644 --- a/doc/UnitTests.txt +++ b/doc/UnitTests.txt @@ -1,19 +1,25 @@ - ================================================================= 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 ======================================= @@ -200,3 +206,12 @@ to test LifeCycleCORBA_SWIG interface. + +------------------------------------------------------------------------------- + ++----------------------------------+------------------------------------------+ +| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ | ++----------------------------------+------------------------------------------+ + +.. _`General KERNEL documentation`: ./index.html +.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/main.html diff --git a/doc/index.txt b/doc/index.txt index aebc24f86..88c66de39 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,76 +1,73 @@ - ================================================================= -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. @@ -78,9 +75,36 @@ 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 diff --git a/doc/kernel_resources.txt b/doc/kernel_resources.txt index 2c65d2236..a162d1769 100644 --- a/doc/kernel_resources.txt +++ b/doc/kernel_resources.txt @@ -6,6 +6,8 @@ SALOME Kernel resources for developer rst2html doc.txt > doc.html +*This document corresponds to SALOME2 3.2.0 (beta version)* + :Authors: Antoine Yessayan, Paul Rascle @@ -16,6 +18,8 @@ SALOME Kernel resources for developer | **WORK in PROGRESS, INCOMPLETE DOCUMENT** | +-------------------------------------------+ +------------------------------------------------------------------------------- + **Abstract** This document describes the development environment for @@ -32,6 +36,8 @@ connection and disconnection. .. contents:: .. sectnum:: +------------------------------------------------------------------------------- + Trace and debug Utilities ========================= @@ -489,3 +495,13 @@ design: * 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 diff --git a/doc/rst.css b/doc/rst.css index eb02941b5..38bd7dcab 100644 --- a/doc/rst.css +++ b/doc/rst.css @@ -97,23 +97,23 @@ div.topic { 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 { diff --git a/doc/salome/tui/KERNEL/doxyuser.in b/doc/salome/tui/KERNEL/doxyuser.in new file mode 100644 index 000000000..bc41af552 --- /dev/null +++ b/doc/salome/tui/KERNEL/doxyuser.in @@ -0,0 +1,202 @@ +# 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 diff --git a/doc/salome/tui/KERNEL/sources/doxygen.css b/doc/salome/tui/KERNEL/sources/doxygen.css new file mode 100755 index 000000000..bda046724 --- /dev/null +++ b/doc/salome/tui/KERNEL/sources/doxygen.css @@ -0,0 +1,149 @@ +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 } diff --git a/doc/salome/tui/KERNEL/sources/footer.html b/doc/salome/tui/KERNEL/sources/footer.html new file mode 100755 index 000000000..82d62c743 --- /dev/null +++ b/doc/salome/tui/KERNEL/sources/footer.html @@ -0,0 +1,19 @@ + + + + + + diff --git a/doc/salome/tui/KERNEL/sources/html_comments.gif b/doc/salome/tui/KERNEL/sources/html_comments.gif new file mode 100755 index 0000000000000000000000000000000000000000..f0c0f0b47100447f7d3a8104b0b4930c548f5437 GIT binary patch literal 156 zcmV;N0Av40Nk%w1VQT;h0Du4hv>+h=|NkNW6+?1mVRU6=Aa`kWXdqN*WgtgMO;7+K z`2+z90096j00000YXAuV00LT!kEzS;4#1l<$#<*OH8amG5(oyRc7{m0hHSLOstHBc z2p=%3&u96YxeS>bktgh7J}aBf$+6{%G-U^B!de@_Bt+>MZM~unISNh_&rFnzZP`Jm KJ9x`c0029x$~vY1 literal 0 HcmV?d00001 diff --git a/doc/salome/tui/KERNEL/sources/myheader.html b/doc/salome/tui/KERNEL/sources/myheader.html index 83ca543cd..538f8f5d5 100755 --- a/doc/salome/tui/KERNEL/sources/myheader.html +++ b/doc/salome/tui/KERNEL/sources/myheader.html @@ -7,18 +7,16 @@ - - - - - - - - -

- - + + + + + + + + +

General KERNEL Documentation

End User KERNEL Services

End User KERNEL Doxygen Documentation

+
+

diff --git a/doc/salome/tui/KERNEL/sources/static/doxygen.css b/doc/salome/tui/KERNEL/sources/static/doxygen.css index 0a8e93d50..bda046724 100755 --- a/doc/salome/tui/KERNEL/sources/static/doxygen.css +++ b/doc/salome/tui/KERNEL/sources/static/doxygen.css @@ -1,21 +1,118 @@ -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; @@ -28,6 +125,8 @@ TD.indexkey { 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; @@ -40,6 +139,7 @@ TD.indexvalue { margin-top : 2px; margin-bottom : 2px } + span.keyword { color: #008000 } span.keywordtype { color: #604020 } span.keywordflow { color: #e08000 } diff --git a/doc/salome/tui/Makefile.am b/doc/salome/tui/Makefile.am index a1e17c6a6..f8a3770c9 100644 --- a/doc/salome/tui/Makefile.am +++ b/doc/salome/tui/Makefile.am @@ -14,25 +14,22 @@ dist-hook: 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 diff --git a/doc/userguide.txt b/doc/userguide.txt index 96bbfb6b0..06238919f 100644 --- a/doc/userguide.txt +++ b/doc/userguide.txt @@ -1,11 +1,22 @@ - ================================================================= 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 ... @@ -123,3 +134,12 @@ prerequisites, compilation procedure, setting environment principles. .. _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 -- 2.39.2