]> SALOME platform Git repositories - modules/kernel.git/commitdiff
Salome HOME
Update build and install processes for GUI and TUI documentation.
authormkr <mkr@opencascade.com>
Mon, 29 May 2006 13:58:37 +0000 (13:58 +0000)
committermkr <mkr@opencascade.com>
Mon, 29 May 2006 13:58:37 +0000 (13:58 +0000)
12 files changed:
doc/Makefile.am
doc/salome/DevelopersGuide/Makefile.am
doc/salome/KERNEL_index.html [deleted file]
doc/salome/Makefile.am
doc/salome/tui/KERNEL/doxyuser.in
doc/salome/tui/KERNEL/sources/Application-About.png [deleted file]
doc/salome/tui/KERNEL/sources/bg_salome.gif [deleted file]
doc/salome/tui/KERNEL/sources/doxygen.css
doc/salome/tui/KERNEL/sources/footer.html
doc/salome/tui/KERNEL/sources/myheader.html
doc/salome/tui/KERNEL/sources/static/doxygen.css
doc/salome/tui/Makefile.am

index 5d867184ed8776fb50d3dc8ad55dff65145ec035..4e7ec38fb24745d0298fe9949b4046efa4a28648 100644 (file)
@@ -51,5 +51,8 @@ RSTOPTS=--output-encoding=latin1 --stylesheet=$(STYLESHEET)
 %.html: $(srcdir)/%.txt
        $(RST2HTML) $(RSTOPTS) $< $@
 
-userdoc:
-       (cd salome && $(MAKE) $(AM_MAKEFLAGS) userdoc)
\ No newline at end of file
+docs:
+       (cd salome && $(MAKE) $(AM_MAKEFLAGS) docs)
+       
+dev_docs:
+       (cd salome && $(MAKE) $(AM_MAKEFLAGS) dev_docs)
\ No newline at end of file
index 1e896f5c7562348d60b95076b936558749da4edd..514ff91d58ecbd8832b4609459c3b8b6a6813526 100644 (file)
@@ -29,8 +29,8 @@ TEX=DevelopersGuide.tex
 TEX_PS=$(TEX:%.tex=%.ps)
 TEX_PDF=$(TEX:%.tex=%.pdf)
 
-#userdoc: $(TEX_PS) $(TEX_PDF)
-userdoc:
+#docs: $(TEX_PS) $(TEX_PDF)
+docs:
        @echo document tex a revoir
 
 clean:
diff --git a/doc/salome/KERNEL_index.html b/doc/salome/KERNEL_index.html
deleted file mode 100644 (file)
index e382f35..0000000
+++ /dev/null
@@ -1,95 +0,0 @@
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
-                                            
-  <meta http-equiv="Content-Type"
- content="text/html; charset=iso-8859-1">
-                                            
-  <meta name="GENERATOR"
- content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
-  <title>Kernel Module Documentation</title>
-</head>
-  <body bgcolor="#cccccc" text="#000000" link="#0000ee" alink="#0000ee"
- vlink="#551a8b">
-       
-<div align="center">    &nbsp;           
-<center>          
-<center>&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
- &nbsp;&nbsp;</center>
-       
-<table width="96%" align="center">
-           <tbody>
-              <tr>
-           <td><a href="http://www.opencascade.com"><img
- src="tui/KERNEL/sources/logocorp.gif" border="0" height="46" width="122">
-                </a></td>
-             <td>                                                       
-               
-      <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
- src="tui/KERNEL/sources/application.gif" border="0" height="46" width="108">
-                </a></div>
-           </td>
-           </tr>
-                                                      
-  </tbody>    
-</table>
-       
-<div align="center">    
-<center>    
-<hr width="100%" size="2">   
-<h1>Kernel MODULE Documentation</h1>
-                                     </center>
-    </div>
-       
-<table width="96%">
-      <tbody>
-               
-  </tbody>    
-</table>
-    </center>
-       
-<div align="center">       
-<p> <img src="tui/KERNEL/sources/Application-About.png"
- alt="Application-About.png" width="30%" height="20%">
-    &nbsp; &nbsp;&nbsp;          </p>
-             </div>
-       
-<center>    
-<table width="96%">
-      <tbody>
-                 
-  </tbody>    
-</table>
-   <br>
-   <br>
-   <br>
-   </center>
-     
-<address> </address>
-   
-<center><big><a href="gui/KERNEL/kernel.html">GUI Documentation</a></big></center>
-      
-<address> </address>
-   
-<center></center>
-      
-<center><br>
-   </center>
-     
-<address> </address>
-   
-<center><big><a href="tui/KERNEL/index.html">TUI Documentation</a></big></center>
-      
-<address> </address>
-   
-<center></center>
-      
-<center><br>
-   <br>
-    </center>
-    </div>
-     <br>
-  <br>
- <br>
-</body>
-</html>
index ce19deb696f3862a684f489d6809590cab5cecfd..e8a286ef96979d47d7a2b71f2b0d3248e2f2eb26 100644 (file)
 include $(top_srcdir)/salome_adm/unix/make_common_starter.am
 
 SUBDIRS= tui DevelopersGuide
+SUBDIRSGUI= DevelopersGuide
+SUBDIRSTUI= tui
 
 index_html:
        $(INSTALL) -d $(docdir); 
-       cp -f $(srcdir)/KERNEL_index.html $(docdir)
 
-userdoc: index_html
-       list='$(SUBDIRS)'; for subdir in $$list; do \
+docs: index_html
+       list='$(SUBDIRSGUI)'; for subdir in $$list; do \
          echo "Making userdoc in $$subdir"; \
-         (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) userdoc) \
+         (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) docs) \
+       done;
+
+dev_docs: index_html
+       list='$(SUBDIRSTUI)'; for subdir in $$list; do \
+         echo "Making userdoc in $$subdir"; \
+         (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) dev_docs) \
        done;
index bc41af552beb658d6e944fbe78dc91f60a25f6d8..c6933ff0a54cfb512291bd1311b81be752185685 100644 (file)
@@ -1,70 +1,89 @@
-# Doxyfile 1.3-rc1
+# Doxyfile 1.4.6
 
 #---------------------------------------------------------------------------
-# General configuration options
+# Project related configuration options
 #---------------------------------------------------------------------------
 PROJECT_NAME           = "SALOME v.@VERSION@"
-PROJECT_NUMBER         = id#1.1
+PROJECT_NUMBER         = 
 OUTPUT_DIRECTORY       = ../
+CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
+USE_WINDOWS_ENCODING   = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = NO
+ABBREVIATE_BRIEF       = 
+ALWAYS_DETAILED_SEC    = YES
+INLINE_INHERITED_MEMB  = YES
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        = @top_builddir@ \
+                        @top_srcdir@
+STRIP_FROM_INC_PATH    = 
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP         = NO
+INHERIT_DOCS           = YES
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 5
+ALIASES                = 
+OPTIMIZE_OUTPUT_FOR_C  = YES
+OPTIMIZE_OUTPUT_JAVA   = NO
+BUILTIN_STL_SUPPORT    = NO
+DISTRIBUTE_GROUP_DOC   = NO
+SUBGROUPING            = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
 EXTRACT_ALL            = YES
 EXTRACT_PRIVATE        = NO
 EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = NO
 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_BRIEF_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
+SHOW_DIRECTORIES       = NO
+FILE_VERSION_FILTER    = 
+
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
 QUIET                  = NO
 WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
 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
+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                = 
@@ -75,7 +94,9 @@ EXAMPLE_PATTERNS       =
 EXAMPLE_RECURSIVE      = NO
 IMAGE_PATH             = sources/
 INPUT_FILTER           = 
+FILTER_PATTERNS        = 
 FILTER_SOURCE_FILES    = YES
+
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
 #---------------------------------------------------------------------------
@@ -84,12 +105,16 @@ INLINE_SOURCES         = NO
 STRIP_CODE_COMMENTS    = YES
 REFERENCED_BY_RELATION = NO
 REFERENCES_RELATION    = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = YES
+
 #---------------------------------------------------------------------------
 # configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
 ALPHABETICAL_INDEX     = YES
-COLS_IN_ALPHA_INDEX    = 5
+COLS_IN_ALPHA_INDEX    = 3
 IGNORE_PREFIX          = 
+
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
 #---------------------------------------------------------------------------
@@ -106,10 +131,11 @@ HHC_LOCATION           =
 GENERATE_CHI           = NO
 BINARY_TOC             = YES
 TOC_EXPAND             = YES
-DISABLE_INDEX          = YES
+DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 4
-GENERATE_TREEVIEW      = YES
+GENERATE_TREEVIEW      = NO
 TREEVIEW_WIDTH         = 250
+
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
@@ -124,6 +150,8 @@ LATEX_HEADER           =
 PDF_HYPERLINKS         = NO
 USE_PDFLATEX           = NO
 LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+
 #---------------------------------------------------------------------------
 # configuration options related to the RTF output
 #---------------------------------------------------------------------------
@@ -133,6 +161,7 @@ COMPACT_RTF            = NO
 RTF_HYPERLINKS         = NO
 RTF_STYLESHEET_FILE    = 
 RTF_EXTENSIONS_FILE    = 
+
 #---------------------------------------------------------------------------
 # configuration options related to the man page output
 #---------------------------------------------------------------------------
@@ -140,16 +169,21 @@ GENERATE_MAN           = NO
 MAN_OUTPUT             = man
 MAN_EXTENSION          = .3
 MAN_LINKS              = NO
+
 #---------------------------------------------------------------------------
 # configuration options related to the XML output
 #---------------------------------------------------------------------------
 GENERATE_XML           = NO
+XML_OUTPUT             = xml
 XML_SCHEMA             = 
 XML_DTD                = 
+XML_PROGRAMLISTING     = YES
+
 #---------------------------------------------------------------------------
 # configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
 GENERATE_AUTOGEN_DEF   = NO
+
 #---------------------------------------------------------------------------
 # configuration options related to the Perl module output
 #---------------------------------------------------------------------------
@@ -157,6 +191,7 @@ GENERATE_PERLMOD       = NO
 PERLMOD_LATEX          = NO
 PERLMOD_PRETTY         = YES
 PERLMOD_MAKEVAR_PREFIX = 
+
 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor   
 #---------------------------------------------------------------------------
@@ -169,14 +204,16 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = 
 EXPAND_AS_DEFINED      = 
 SKIP_FUNCTION_MACROS   = NO
+
 #---------------------------------------------------------------------------
-# Configuration::addtions related to external references   
+# Configuration::additions related to external references   
 #---------------------------------------------------------------------------
 TAGFILES               = 
 GENERATE_TAGFILE       = 
 ALLEXTERNALS           = NO
 EXTERNAL_GROUPS        = YES
 PERL_PATH              = /usr/bin/perl
+
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool   
 #---------------------------------------------------------------------------
@@ -185,18 +222,26 @@ HIDE_UNDOC_RELATIONS   = NO
 HAVE_DOT               = YES
 CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = NO
+GROUP_GRAPHS           = NO
+UML_LOOK               = NO
 TEMPLATE_RELATIONS     = YES
 INCLUDE_GRAPH          = YES
 INCLUDED_BY_GRAPH      = NO
+CALL_GRAPH             = NO
 GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
 DOT_IMAGE_FORMAT       = jpg
 DOT_PATH               = 
 DOTFILE_DIRS           = 
 MAX_DOT_GRAPH_WIDTH    = 1024
 MAX_DOT_GRAPH_HEIGHT   = 1200
+MAX_DOT_GRAPH_DEPTH    = 0
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = NO
 GENERATE_LEGEND        = NO
 DOT_CLEANUP            = YES
+
 #---------------------------------------------------------------------------
-# Configuration::addtions related to the search engine   
+# Configuration::additions related to the search engine   
 #---------------------------------------------------------------------------
 SEARCHENGINE           = NO
diff --git a/doc/salome/tui/KERNEL/sources/Application-About.png b/doc/salome/tui/KERNEL/sources/Application-About.png
deleted file mode 100755 (executable)
index 7b58330..0000000
Binary files a/doc/salome/tui/KERNEL/sources/Application-About.png and /dev/null differ
diff --git a/doc/salome/tui/KERNEL/sources/bg_salome.gif b/doc/salome/tui/KERNEL/sources/bg_salome.gif
deleted file mode 100644 (file)
index c7e0306..0000000
Binary files a/doc/salome/tui/KERNEL/sources/bg_salome.gif and /dev/null differ
index bda0467241b4e5a526d2e9a458edfb79368f3dce..88e613d2392388224ab7c6ba85e7aafb73185dac 100755 (executable)
@@ -95,11 +95,32 @@ DIV.groupText {
 }
 
 BODY { 
-   background: url(sources/bg_salome.gif) 
+   background: #FFFFFF;
 }
 
+/*div.div-page { 
+  background-color: #FFFFFF; 
+  margin-left: 1em;
+  margin-right: 1em;
+  margin-top: 1em;
+  margin-bottom: 0.1em;
+
+  padding-left: 1em;
+  padding-right: 1em;
+  padding-top: 0.5em;
+  padding-bottom: 0.5em;
+
+  border: 2px solid #0D299A; 
+  border-width: 2px;
+  border-color: #0D299A; 
+}*/
+
 div.tabs { 
   text-align: justify; 
+  margin-left    : 2px;         
+  margin-right   : 2px;  
+  margin-top     : 2px; 
+  margin-bottom  : 2px
   font-weight: bold;
   color: #FFFFFF;
 }
index 21d9c1314f790b8c905dae61234d3214be876fe9..c9fdcfc9d8586a79e240df63178743e9a8f69164 100755 (executable)
@@ -1,18 +1,4 @@
-</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>&nbsp;&nbsp;<a href="../../index.html" target = _top>General KERNEL Documentation</a>&nbsp;&nbsp;</td>
-      <td>&nbsp;&nbsp;<a href="../../KERNEL_Services.html" target = _top>End User KERNEL Services</a>&nbsp;&nbsp;</td>
-    </tr>
-  </tbody>
-</table>
-<br>
 Generated on $datetime for $projectname by&nbsp;<A href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></A> $doxygenversion</DIV>
 </BODY>
 </HTML>
index bcb2ed14c2b03794ec03971928925963027627b2..25bfe5ec36b1fae795eb8f5f4ed7b2d1961df808 100755 (executable)
@@ -5,10 +5,12 @@
    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
    <title>Main Page</title>
 <link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
 </head>
 <body>
-<table cellspacing="2" align="center" bgcolor="#808080" frame="void">
-  <tbody align="center" valign="center" bgcolor="#D3D3D3">
+&nbsp;
+<table cellspacing="2" align="center" bgcolor="#FFFFFF" frame="void">
+  <tbody align="center" valign="center" bgcolor="#FFFFFF">
     <tr>
       <td>&nbsp;&nbsp;<a href="../../index.html" target = _top>General KERNEL Documentation</a>&nbsp;&nbsp;</td>
       <td>&nbsp;&nbsp;<a href="../../KERNEL_Services.html" target = _top>End User KERNEL Services</a>&nbsp;&nbsp;</td>
index bda0467241b4e5a526d2e9a458edfb79368f3dce..88e613d2392388224ab7c6ba85e7aafb73185dac 100755 (executable)
@@ -95,11 +95,32 @@ DIV.groupText {
 }
 
 BODY { 
-   background: url(sources/bg_salome.gif) 
+   background: #FFFFFF;
 }
 
+/*div.div-page { 
+  background-color: #FFFFFF; 
+  margin-left: 1em;
+  margin-right: 1em;
+  margin-top: 1em;
+  margin-bottom: 0.1em;
+
+  padding-left: 1em;
+  padding-right: 1em;
+  padding-top: 0.5em;
+  padding-bottom: 0.5em;
+
+  border: 2px solid #0D299A; 
+  border-width: 2px;
+  border-color: #0D299A; 
+}*/
+
 div.tabs { 
   text-align: justify; 
+  margin-left    : 2px;         
+  margin-right   : 2px;  
+  margin-top     : 2px; 
+  margin-bottom  : 2px
   font-weight: bold;
   color: #FFFFFF;
 }
index 42d60db060f60ff2fb7aab7796fb11a1156910dc..43a8ee9640e786fe70bda2551f78e28707bb0076 100644 (file)
@@ -30,7 +30,7 @@ EXTRA_DIST = $(srcdir)/KERNEL
 dist-hook:
        rm -rf `find $(distdir) -name CVS`
 
-userdoc:
+dev_docs:
        cp -fr $(srcdir)/KERNEL/* ./INPUT; \
        cd ./INPUT; \
         pwd; ls;\