From 8538b3c0794ed96ee40b973f4c3c076b5ec66cda Mon Sep 17 00:00:00 2001 From: mkr Date: Wed, 24 May 2006 08:07:59 +0000 Subject: [PATCH] Update TUI documentation for Med module. --- doc/salome/MED_index_v3.1.0.html | 94 ----------- doc/salome/Makefile.in | 3 - doc/salome/tui/MED/doxyfile | 21 +-- doc/salome/tui/MED/sources/footer.html | 5 + doc/salome/tui/MED/sources/myheader.html | 13 +- doc/salome/tui/MED/sources/static/doxygen.css | 153 ++++++++++++++++-- doc/salome/tui/Makefile.in | 3 +- 7 files changed, 156 insertions(+), 136 deletions(-) delete mode 100644 doc/salome/MED_index_v3.1.0.html create mode 100755 doc/salome/tui/MED/sources/footer.html diff --git a/doc/salome/MED_index_v3.1.0.html b/doc/salome/MED_index_v3.1.0.html deleted file mode 100644 index 5217304ed..000000000 --- a/doc/salome/MED_index_v3.1.0.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - - - Med Module Documentation - - - -

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

- -

Med MODULE Documentation

- -

- - - - - -

- - -

- - - - - - -

-
- - -

-
- -

- - - -
- - -

- -TUI Documentation - -

- - - -
-
- -

-
-
-
-
- - diff --git a/doc/salome/Makefile.in b/doc/salome/Makefile.in index c19de8770..7616717c0 100644 --- a/doc/salome/Makefile.in +++ b/doc/salome/Makefile.in @@ -19,7 +19,6 @@ docs: @@SETX@; for d in $(SUBDIRS); do \ (cd $$d && $(MAKE) $@) || exit 1; \ done; \ - cp -f $(srcdir)/MED_index_v3.1.0.html MED_index_v3.1.0.html clean: @@SETX@; for d in $(SUBDIRS); do \ @@ -34,10 +33,8 @@ distclean: clean install: $(MAKE) docs (cd tui && $(MAKE) install); - cp -f MED_index_v3.1.0.html $(docdir) uninstall: @@SETX@; for d in $(SUBDIRS); do \ (cd $$d && $(MAKE) $@) || exit 1; \ done; \ - rm -fr $(docdir)/MED_index_v3.1.0.html diff --git a/doc/salome/tui/MED/doxyfile b/doc/salome/tui/MED/doxyfile index 7b65febdb..943189540 100755 --- a/doc/salome/tui/MED/doxyfile +++ b/doc/salome/tui/MED/doxyfile @@ -3,8 +3,8 @@ #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = "SALOME - MED - v.3.2.0b1" -PROJECT_NUMBER = id#1.1 +PROJECT_NAME = "SALOME - MED - v.version" +PROJECT_NUMBER = OUTPUT_DIRECTORY = ../ CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English @@ -14,8 +14,9 @@ REPEAT_BRIEF = YES ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = ../../../share/salome \ + ../../../build/salome STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES @@ -98,8 +99,8 @@ VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO -COLS_IN_ALPHA_INDEX = 5 +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 3 IGNORE_PREFIX = #--------------------------------------------------------------------------- @@ -109,8 +110,8 @@ GENERATE_HTML = YES HTML_OUTPUT = MED HTML_FILE_EXTENSION = .html HTML_HEADER = sources/myheader.html -HTML_FOOTER = -HTML_STYLESHEET = +HTML_FOOTER = sources/footer.html +HTML_STYLESHEET = sources/static/doxygen.css HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO CHM_FILE = @@ -118,9 +119,9 @@ 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 #--------------------------------------------------------------------------- diff --git a/doc/salome/tui/MED/sources/footer.html b/doc/salome/tui/MED/sources/footer.html new file mode 100755 index 000000000..cb55f397a --- /dev/null +++ b/doc/salome/tui/MED/sources/footer.html @@ -0,0 +1,5 @@ + + + + diff --git a/doc/salome/tui/MED/sources/myheader.html b/doc/salome/tui/MED/sources/myheader.html index 83ca543cd..d2efb75fa 100755 --- a/doc/salome/tui/MED/sources/myheader.html +++ b/doc/salome/tui/MED/sources/myheader.html @@ -5,20 +5,9 @@ Main Page + - - - - - - - -

- - diff --git a/doc/salome/tui/MED/sources/static/doxygen.css b/doc/salome/tui/MED/sources/static/doxygen.css index 0a8e93d50..88e613d23 100755 --- a/doc/salome/tui/MED/sources/static/doxygen.css +++ b/doc/salome/tui/MED/sources/static/doxygen.css @@ -1,21 +1,139 @@ -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: #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; +} + +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 +146,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 +160,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.in b/doc/salome/tui/Makefile.in index 5434c5517..daffe6917 100644 --- a/doc/salome/tui/Makefile.in +++ b/doc/salome/tui/Makefile.in @@ -21,7 +21,8 @@ docs: cd INPUT; \ sed 's|../../../share/salome|$(root_srcdir)|' ./doxyfile > ./doxyfile1; \ sed 's|../../build/salome|$(top_builddir)|' ./doxyfile1 > ./doxyfile2; \ - mv -f doxyfile2 doxyfile1; \ + sed "s|version|`cut -d: -f2 $(root_srcdir)/bin/VERSION`|" ./doxyfile2 > ./doxyfile3; \ + mv -f doxyfile3 doxyfile1; \ 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; \ -- 2.39.2