ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2025-01-27 08:50:33 +05:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation style and interface

Browse Source
This commit is contained in:
dmv 2010-04-06 14:27:51 +00:00
parent 53bdd5f837
commit 76f9fd0af8
23 changed files with 432 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
configure.ac
View File

@ -389,8 +389,10 @@ AC_OUTPUT([ \
doc/salome/gui/GEOM/doxyfile \
doc/salome/gui/GEOM/doxyfile_py \
doc/salome/gui/GEOM/doxyfile_tui \
doc/salome/gui/GEOM/static/header.html \
doc/salome/tui/Makefile \
doc/salome/tui/doxyfile \
doc/salome/tui/static/header.html \
src/Makefile \
src/AdvancedGUI/Makefile \
src/ARCHIMEDE/Makefile \

13
doc/salome/gui/GEOM/Makefile.am
View File

@ -26,9 +26,12 @@
#
include $(top_srcdir)/adm_local/unix/make_common_starter.am
EXTRA_DIST += images input static
EXTRA_DIST += images input static/footer.html static/doxygen.css
usr_docs: doxyfile_tui doxyfile_py doxyfile
guidocdir = $(docdir)/gui/GEOM
guidoc_DATA = images/head.png
usr_docs: doxyfile_tui doxyfile_py doxyfile
echo "===========================================" ; \
echo "Replacing geompyDC by geompy" ; \
echo "===========================================" ; \
@ -46,13 +49,13 @@ usr_docs: doxyfile_tui doxyfile_py doxyfile
echo "===========================================" ; \
echo "Generating GUI documentation" ; \
echo "===========================================" ; \
$(DOXYGEN) doxyfile ; \
$(DOXYGEN) doxyfile ; \
rm -f $(top_builddir)/src/GEOM_SWIG/geompy.py
docs: usr_docs
clean-local:
@for filen in `find . -maxdepth 1` ; do \
@for filen in `find . -maxdepth 1` ; do \
case $${filen} in \
./Makefile | ./doxyfile | ./doxyfile_py | ./doxyfile_tui ) ;; \
. | .. ) ;; \
@ -62,7 +65,7 @@ clean-local:
install-data-local: usr_docs
$(INSTALL) -d $(DESTDIR)$(docdir)/gui/GEOM
@for filen in `find . -maxdepth 1` ; do \
@for filen in `find . -maxdepth 1` ; do \
case $${filen} in \
./Makefile | ./doxyfile | ./doxyfile_py | ./doxyfile_tui ) ;; \
./doxyfile.bak | ./doxyfile_py.bak | ./doxyfile_tui.bak ) ;; \

6
doc/salome/gui/GEOM/doxyfile.in
View File

@ -23,7 +23,7 @@
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "Geometry Module Reference Manual v.@VERSION@"
PROJECT_NAME = "SALOME Geometry User's Guide"
OUTPUT_DIRECTORY = .
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
@ -49,9 +49,9 @@ EXAMPLE_PATH = @top_srcdir@/src/GEOM_SWIG
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = .
HTML_HEADER = @srcdir@/static/header.html
HTML_HEADER = @builddir@/static/header.html
HTML_FOOTER = @srcdir@/static/footer.html
#HTML_STYLESHEET = @srcdir@/static/doxygen.css
HTML_STYLESHEET = @srcdir@/static/doxygen.css
TOC_EXPAND = YES
DISABLE_INDEX = NO
GENERATE_TREEVIEW = YES

2
doc/salome/gui/GEOM/doxyfile_py.in
View File

@ -110,7 +110,7 @@ RECURSIVE = NO
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = geompy_doc
HTML_HEADER = @srcdir@/static/header.html
HTML_HEADER = @builddir@/static/header.html
HTML_FOOTER = @srcdir@/static/footer.html
#HTML_STYLESHEET = @srcdir@/static/doxygen.css
TOC_EXPAND = YES

2
doc/salome/gui/GEOM/doxyfile_tui.in
View File

@ -48,7 +48,7 @@ EXAMPLE_PATH = @top_srcdir@/src/GEOM_SWIG
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = .
HTML_HEADER = @srcdir@/static/header.html
HTML_HEADER = @builddir@/static/header.html
HTML_FOOTER = @srcdir@/static/footer.html
#HTML_STYLESHEET = @srcdir@/static/doxygen.css
TOC_EXPAND = YES

BIN
doc/salome/gui/GEOM/images/box3.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 18 KiB

BIN
doc/salome/gui/GEOM/images/geomscreen.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 104 KiB

BIN
doc/salome/gui/GEOM/images/head.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 77 KiB

BIN
doc/salome/gui/GEOM/images/iges_unit.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 6.3 KiB

BIN
doc/salome/gui/GEOM/images/sat_named_shapes.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 7.0 KiB

BIN
doc/salome/gui/GEOM/images/using_notebook_geom.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 13 KiB

1
doc/salome/gui/GEOM/input/geometrical_object_properties.doc
View File

@ -67,7 +67,6 @@ The possible values of the geometrical objects are listed in the table below:
<tr align=center><td>44</td><td>3DSKETCHER</td></tr>
<tr align=center><td>45</td><td>FILLET_2D</td></tr>
<tr align=center><td>46</td><td>FILLET_1D</td></tr>
<tr align=center><td>&nbps;</td><td>&nbps;</td></tr>
</table>
Also geompy.py module provides a helper function ShapeIdToType()

195
doc/salome/gui/GEOM/static/doxygen.css
View File

@ -1,5 +1,35 @@
H1 {
body {
font-family: Arial, Helvetica, sans-serif;
background-color: #ffffff;
}
h1 {
text-align: center;
text-decoration: none;
border: none;
line-height: 25px;
text-align: center;
// text-transform:uppercase;
background: #D9f4fd;
font-size: 12pt;
font-weight: bold;
border: 1px solid #CCCCCC;
-moz-border-radius: 8px;
-moz-box-shadow:5px 5px 5px rgba(0, 0, 0, 0.15);
/* background-color: rgb(75, 140, 185);
color: #ffffff;
text-align: center;
height: 25px;*/
}
h2 {
font-size: 12pt;
font-weight: bold;
}
table {
font-size: 10pt;
}
CAPTION {
@ -11,16 +41,6 @@ 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)
*/
@ -37,7 +57,49 @@ A.codeRef {
A:hover {
text-decoration: none;
background-color: lightblue
background-color: lightblue;
}
div.contents {
font-family: Arial, Helvetica, sans-serif;
font-size: 10pt;
}
div.navpath {
font-size: 11pt;
}
div.version {
background-color:#ffffde;
border:1px solid #cccccc;
font-family: Arial, Helvetica, sans-serif;
font-size: 9pt;
text-align: center;
width:100px;
-moz-border-radius: 8px;
// -moz-box-shadow:5px 5px 5px rgba(0, 0, 0, 0.15);
}
div.header {
background: url("head.png");
background-color: #175783;
border: 1px solid;
height: 80px;
background-repeat: no-repeat;
margin-bottom: 10px;
}
div.tabs {
display: none;
}
div.footer {
background-color: #D9f4fd;
border: 1px solid #AAAAAA;
font-family: Arial, Helvetica, sans-serif;
font-size: 11px;
padding: 10px;
margin-top: 15px;
}
DL.el {
@ -45,10 +107,8 @@ DL.el {
}
/* A code fragment (ex: header) */
DIV.fragment {
width: 100%;
div.fragment {
border: none;
background-color: #CCCCCC
}
/* In the alpha list (coumpound index), style of an alphabetical index letter */
@ -94,10 +154,6 @@ DIV.groupText {
font-size: smaller
}
BODY {
background: #FFFFFF;
}
/*div.div-page {
background-color: #FFFFFF;
margin-left: 1em;
@ -168,3 +224,104 @@ span.comment { color: #800000 }
span.preprocessor { color: #806020 }
span.stringliteral { color: #002080 }
span.charliteral { color: #008080 }
/* @group Code Colorization */
.fragment {
font-family: monospace, fixed;
font-size: 10pt;
}
pre.fragment {
width: 95%;
border: 1px solid #CCCCCC;
-moz-border-radius: 8px;
-moz-box-shadow:5px 5px 5px rgba(0, 0, 0, 0.15);
background-color:#EEF3F5;
padding: 4px 6px;
margin: 4px 1px 4px 1px;
}
/* Top Navigation style */
div.navigation {
margin-bottom:20px;
}
/* Left navigation panel style */
body.ftvtree {
background-color: #D9f4fd;
margin: 10px;
}
div.directory {
margin: 0;
}
div.directory.p {
margin: 0;
}
h3.swap {
font-size: 10pt;
margin-bottom: 0;
}
/* Link to any cross-referenced Doxygen element */
a.el {
text-decoration: none;
font-family: Arial, Helvetica, sans-serif;
font-weight: bold;
font-size: 9pt;
color: #551a8b;
}
a.el:hover {
background-color: transparent;
}
a.elRef {
font-weight: normal;
}
#MSearchBox {
-moz-border-radius:8px 8px 8px 8px;
background-color:white;
border:1px solid #84B0C7;
margin:0;
padding:0;
white-space:nowrap;
}
div.directory img {
vertical-align:-30%;
}
div.directory p {
white-space:nowrap;
margin: 0;
}
div.directory-alt div {
display: none;
margin: 0px;
}
div.directory div {
display: none;
margin: 0px;
}
div.version {
background-color:#ffffde;
border:1px solid #cccccc;
font-family: Arial, Helvetica, sans-serif;
font-size: 9pt;
text-align: center;
width:100px;
-moz-border-radius: 8px;
// -moz-box-shadow:5px 5px 5px rgba(0, 0, 0, 0.15);
}

7
doc/salome/gui/GEOM/static/footer.html
View File

@ -3,10 +3,11 @@
<head>
</head>
<body>
<hr style="width: 100%; height: 2px;">
<div class="footer">
<div style="text-align: center;">
Copyright &copy; 2007-2008 CEA/DEN, EDF R&amp;D, OPEN CASCADE<br>
Copyright &copy; 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&amp;D, LEG, PRINCIPIA R&amp;D, BUREAU VERITAS<br>
Copyright &copy; 2007-2010 CEA/DEN, EDF R&amp;D, OPEN CASCADE<br>
Copyright &copy; 2003-2010 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&amp;D, LEG, PRINCIPIA R&amp;D, BUREAU VERITAS<br>
</div>
</div>
</body>
</html>

8
doc/salome/gui/GEOM/static/header.html → doc/salome/gui/GEOM/static/header.html.in
View File

@ -5,8 +5,6 @@
<title>$title</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<hr>
<center>
SALOME documentation central
</center>
<hr>
<div class="header"></div>
<div align="right"><div class="version">Version: @VERSION@</div></div>

5
doc/salome/tui/Makefile.am
View File

@ -25,7 +25,10 @@
#
include $(top_srcdir)/adm_local/unix/make_common_starter.am
EXTRA_DIST += images static
EXTRA_DIST += images input static/footer.html static/doxygen.css
tuidocdir = $(docdir)/tui/GEOM
tuidoc_DATA = images/head.png images/geomscreen.png
dev_docs: doxyfile
echo "===========================================" ; \

9
doc/salome/tui/doxyfile.in
View File

@ -25,7 +25,7 @@
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "Geometry Module Programming Guide v.@VERSION@"
PROJECT_NAME = "SALOME Geometry Developer"
PROJECT_NUMBER =
OUTPUT_DIRECTORY = GEOM
CREATE_SUBDIRS = NO
@ -101,8 +101,9 @@ INPUT = @top_srcdir@/src \
@top_builddir@/src/GEOM_SWIG/geompy.py \
@top_srcdir@/bin \
@top_srcdir@/idl \
@top_builddir@/bin
FILE_PATTERNS = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@
@top_builddir@/bin \
@srcdir@/input
FILE_PATTERNS = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc
RECURSIVE = YES
EXCLUDE = @top_srcdir@/src/GEOM_SWIG/geompy.py \
@top_srcdir@/src/GEOM_SWIG/geompyDC.py
@ -140,7 +141,7 @@ IGNORE_PREFIX =
GENERATE_HTML = YES
HTML_OUTPUT = .
HTML_FILE_EXTENSION = .html
HTML_HEADER = @srcdir@/static/myheader.html
HTML_HEADER = @builddir@/static/header.html
HTML_FOOTER = @srcdir@/static/footer.html
HTML_STYLESHEET = @srcdir@/static/doxygen.css
HTML_ALIGN_MEMBERS = YES

BIN
doc/salome/tui/images/geomscreen.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 104 KiB

BIN
doc/salome/tui/images/head.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 77 KiB

15
doc/salome/tui/input/index.doc Normal file
View File

@ -0,0 +1,15 @@
/*! \mainpage
\image html geomscreen.png
To browse the \b SALOME Geometry module Developer Documentation, follow the links below or use navigation menu at the top of the page:
<ul>
<li> <a href="modules.html">Modules</a> - documentation of TUI functionality.</li>
<li> <a href="namespaces.html">Name Spaces</a> - list of TUI packages and scripts.</li>
<li> <a href="hierarchy.html">Class hierarchy</a></li>
<li> <a href="inherits.html">Graphical class hierarchy</a></li>
<li> <a href="annotated.html">Data Structures</a> - list of all data structures and classes with brief descriptions.</li>
<li> <a href="files.html">Files</a> - list of all files with brief descriptions.</li>
</ul>
*/

222
doc/salome/tui/static/doxygen.css
View File

@ -1,5 +1,32 @@
H1 {
body {
font-family: Arial, Helvetica, sans-serif;
background-color: #ffffff;
}
h1 {
text-align: center;
text-decoration: none;
border: none;
line-height: 25px;
text-align: center;
// text-transform:uppercase;
background: #D9f4fd;
font-size: 12pt;
font-weight: bold;
border: 1px solid #CCCCCC;
margin-top: 50px;
-moz-border-radius: 8px;
-moz-box-shadow:5px 5px 5px rgba(0, 0, 0, 0.15);
}
h2 {
font-size: 12pt;
font-weight: bold;
}
table {
font-size: 10pt;
padding-left: 20px;
}
CAPTION {
@ -11,16 +38,6 @@ 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)
*/
@ -37,7 +54,53 @@ A.codeRef {
A:hover {
text-decoration: none;
background-color: lightblue
background-color: lightblue;
}
div.contents {
font-family: Arial, Helvetica, sans-serif;
font-size: 10pt;
padding: 20px;
}
div.navpath {
font-size: 11pt;
}
div.header {
background: url("head.png");
background-color: #175783;
border: 1px solid;
height: 80px;
background-repeat: no-repeat;
margin-bottom:20px;
}
div.tabs {
text-align: justify;
margin-left : 2px;
margin-right : 2px;
margin-top : 2px;
margin-bottom : 2px
font-weight: bold;
color: #FFFFFF;
}
div.footer {
background-color: #D9f4fd;
border: 1px solid #AAAAAA;
font-family: Arial, Helvetica, sans-serif;
font-size: 11px;
padding: 10px;
}
div.div-footer {
background-color: #D9f4fd;
border: 1px solid #AAAAAA;
font-family: Arial, Helvetica, sans-serif;
font-size: 11px;
padding: 10px;
text-align: center;
}
DL.el {
@ -45,10 +108,8 @@ DL.el {
}
/* A code fragment (ex: header) */
DIV.fragment {
width: 100%;
div.fragment {
border: none;
background-color: #CCCCCC
}
/* In the alpha list (coumpound index), style of an alphabetical index letter */
@ -94,10 +155,6 @@ DIV.groupText {
font-size: smaller
}
BODY {
background: #FFFFFF;
}
/*div.div-page {
background-color: #FFFFFF;
margin-left: 1em;
@ -125,17 +182,9 @@ div.tabs {
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;
background-color: #DDDDEE;
font-weight: bold;
padding-right : 10px;
padding-top : 2px;
@ -149,7 +198,7 @@ TD.indexkey {
/* In File List, Coumpound List, etc, 2nd column of the index */
TD.indexvalue {
background-color: #CCCCCC;
background-color: #EEEEFF;
font-style: italic;
padding-right : 10px;
padding-top : 2px;
@ -168,3 +217,118 @@ span.comment { color: #800000 }
span.preprocessor { color: #806020 }
span.stringliteral { color: #002080 }
span.charliteral { color: #008080 }
/* @group Code Colorization */
.fragment {
font-family: monospace, fixed;
font-size: 10pt;
}
pre.fragment {
width: 95%;
border: 1px solid #CCCCCC;
-moz-border-radius: 8px;
-moz-box-shadow:5px 5px 5px rgba(0, 0, 0, 0.15);
background-color:#EEF3F5;
padding: 4px 6px;
margin: 20px;
}
/* Top Navigation style */
div.navigation {
margin-bottom:20px;
}
/* Left navigation panel style */
body.ftvtree {
background-color: #D9f4fd;
margin: 10px;
}
div.directory {
margin: 0;
}
div.directory.p {
margin: 0;
}
h3.swap {
font-size: 10pt;
margin-bottom: 0;
}
/* Link to any cross-referenced Doxygen element */
a.el {
text-decoration: none;
font-family: Arial, Helvetica, sans-serif;
font-weight: bold;
font-size: 10pt;
color: #551a8b;
}
a.el:hover {
background-color: transparent;
color: #551acc;
}
a {
// text-decoration: none;
font-family: Arial, Helvetica, sans-serif;
font-weight: bold;
font-size: 10pt;
color: #551a8b;
}
a:hover {
background-color: transparent;
color: #551acc;
}
a.elRef {
font-weight: normal;
}
#MSearchBox {
-moz-border-radius:8px 8px 8px 8px;
background-color:white;
border:1px solid #84B0C7;
margin:0;
padding:0;
white-space:nowrap;
}
div.directory img {
vertical-align:-30%;
}
div.directory p {
white-space:nowrap;
margin: 0;
}
div.directory-alt div {
display: none;
margin: 0px;
}
div.directory div {
display: none;
margin: 0px;
}
div.version {
background-color:#ffffde;
border:1px solid #cccccc;
font-family: Arial, Helvetica, sans-serif;
font-size: 9pt;
text-align: center;
width:100px;
-moz-border-radius: 8px;
// -moz-box-shadow:5px 5px 5px rgba(0, 0, 0, 0.15);
}

19
doc/salome/tui/static/footer.html
View File

@ -1,5 +1,14 @@
</DIV>
<DIV class="div-footer">
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>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<div class="footer">
<!--hr style="width: 100%; height: 2px;"-->
<div style="text-align: center;">
Copyright &copy; 2007-2010 CEA/DEN, EDF R&amp;D, OPEN CASCADE<br>
Copyright &copy; 2003-2010 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&amp;D, LEG, PRINCIPIA R&amp;D, BUREAU VERITAS<br>
</div>
</div>
</body>
</html>

5
doc/salome/tui/static/myheader.html → doc/salome/tui/static/header.html.in
View File

@ -3,11 +3,12 @@
<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>Main Page</title>
<title>SALOME Geometry Developer Guide</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body>
&nbsp;
<div class="header"></div>
<div align="right"><div class="version">Version: @VERSION@</div></div>
</body>
</html>