From: mkr Date: Mon, 29 May 2006 13:58:37 +0000 (+0000) Subject: Update build and install processes for GUI and TUI documentation. X-Git-Tag: V3_2_0rc~4 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=478711bd28f9893b7686aca7cdbae18d29867822;p=modules%2Fkernel.git Update build and install processes for GUI and TUI documentation. --- diff --git a/doc/Makefile.am b/doc/Makefile.am index 5d867184e..4e7ec38fb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -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 diff --git a/doc/salome/DevelopersGuide/Makefile.am b/doc/salome/DevelopersGuide/Makefile.am index 1e896f5c7..514ff91d5 100644 --- a/doc/salome/DevelopersGuide/Makefile.am +++ b/doc/salome/DevelopersGuide/Makefile.am @@ -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 index e382f356d..000000000 --- a/doc/salome/KERNEL_index.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - Kernel Module Documentation - - - -

- - - - - - - - - - - - -

- -

Kernel MODULE Documentation

- -

- - - - - -

- - -

- - - - - - -

-
-
-
- - -

- -GUI Documentation - -

- - - -
- - -

- -TUI Documentation - -

- - - -
-
- -

-
-
-
- - diff --git a/doc/salome/Makefile.am b/doc/salome/Makefile.am index ce19deb69..e8a286ef9 100644 --- a/doc/salome/Makefile.am +++ b/doc/salome/Makefile.am @@ -26,13 +26,20 @@ 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; diff --git a/doc/salome/tui/KERNEL/doxyuser.in b/doc/salome/tui/KERNEL/doxyuser.in index bc41af552..c6933ff0a 100644 --- a/doc/salome/tui/KERNEL/doxyuser.in +++ b/doc/salome/tui/KERNEL/doxyuser.in @@ -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 index 7b58330d5..000000000 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 index c7e030685..000000000 Binary files a/doc/salome/tui/KERNEL/sources/bg_salome.gif and /dev/null differ diff --git a/doc/salome/tui/KERNEL/sources/doxygen.css b/doc/salome/tui/KERNEL/sources/doxygen.css index bda046724..88e613d23 100755 --- a/doc/salome/tui/KERNEL/sources/doxygen.css +++ b/doc/salome/tui/KERNEL/sources/doxygen.css @@ -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; } diff --git a/doc/salome/tui/KERNEL/sources/footer.html b/doc/salome/tui/KERNEL/sources/footer.html index 21d9c1314..c9fdcfc9d 100755 --- a/doc/salome/tui/KERNEL/sources/footer.html +++ b/doc/salome/tui/KERNEL/sources/footer.html @@ -1,18 +1,4 @@ - - - diff --git a/doc/salome/tui/KERNEL/sources/myheader.html b/doc/salome/tui/KERNEL/sources/myheader.html index bcb2ed14c..25bfe5ec3 100755 --- a/doc/salome/tui/KERNEL/sources/myheader.html +++ b/doc/salome/tui/KERNEL/sources/myheader.html @@ -5,10 +5,12 @@ Main Page + - - + +

+ diff --git a/doc/salome/tui/KERNEL/sources/static/doxygen.css b/doc/salome/tui/KERNEL/sources/static/doxygen.css index bda046724..88e613d23 100755 --- a/doc/salome/tui/KERNEL/sources/static/doxygen.css +++ b/doc/salome/tui/KERNEL/sources/static/doxygen.css @@ -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; } diff --git a/doc/salome/tui/Makefile.am b/doc/salome/tui/Makefile.am index 42d60db06..43a8ee964 100644 --- a/doc/salome/tui/Makefile.am +++ b/doc/salome/tui/Makefile.am @@ -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;\

General KERNEL Documentation

End User KERNEL Services