mirror of
https://github.com/minetest/irrlicht.git
synced 2025-06-28 06:20:21 +02:00
Merging r6172 through r6199 from branch releases/1.8 to trunk
Changes are all related to automatic creation of documentation. Note: It's not yet fully working in trunk due to changes since 1.8 git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@6200 dfc29bdd-3216-0410-991c-e03cc46cb475
This commit is contained in:
cutealien
2442
scripts/doc/irrlicht/doxygen_tutorial.cfg
Normal file
2442
scripts/doc/irrlicht/doxygen_tutorial.cfg
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,3 +1,5 @@
|
||||
mkdir -p ../../../doctemp/html
|
||||
|
||||
rm tut.txt || true;
|
||||
|
||||
mkdir ../../../doctemp
|
||||
@ -8,4 +10,11 @@ for i in ../../../examples/[012]*/main.cpp; do
|
||||
sed -f tutorials.sed $i >>tut.txt;
|
||||
done
|
||||
|
||||
# Enable for latex docs
|
||||
#doxygen doxygen-pdf.cfg
|
||||
|
||||
# Enable for html docs
|
||||
doxygen doxygen.cfg
|
||||
|
||||
#cp doxygen.css ../../../doctemp/html
|
||||
cp irrlicht.png logobig.png ../../../doctemp/html
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
1,+18 d
|
||||
s/src="/src="images\/tutorials\//
|
||||
s/href="/href="docu\//g
|
||||
s/\(.*\) <hr.*$/\1/
|
||||
/<addr/,$ d
|
||||
# run on single_tut.txt which is created in maketutorial.sh (or .bat)
|
||||
|
||||
# replace image links as we don't copy the images into example folders but keep them below media folder
|
||||
s/img src="/img src="..\/..\/media\//
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
type tut_head.html >%2
|
||||
..\sed.exe -f maketut.sed %1 >>%2
|
||||
type tut_end.html >>%2
|
||||
|
||||
REM OUTDATED - don't use this anymore. For now only maketutorial.sh works, this one still has to be updated.
|
||||
REM type tut_head.html >%2
|
||||
REM ..\sed.exe -f maketut.sed %1 >>%2
|
||||
REM type tut_end.html >>%2
|
||||
|
||||
@ -1,4 +1,30 @@
|
||||
cat tut_head.html >$2
|
||||
sed -f maketut.sed $1 >>$2
|
||||
cat tut_end.html >>$2
|
||||
# Create the tutorial.html files in each example folder
|
||||
|
||||
# for every folder below examples
|
||||
for i in ../../../examples/[012]*; do
|
||||
echo NOW doing $i
|
||||
|
||||
# uses the main.cpp files to create some file to use as doxygen input
|
||||
sed -f tutorials.sed $i/main.cpp >single_tut.txt
|
||||
# echo tutorials.sed has run
|
||||
|
||||
# create the html file
|
||||
doxygen doxygen_tutorial.cfg
|
||||
# echo doxygen has run
|
||||
|
||||
# Fix the image links
|
||||
sed -f maketut.sed html/example???.html >tutorial.html
|
||||
# echo maketut.sed has run
|
||||
|
||||
#move to example folder
|
||||
mv tutorial.html $i/tutorial.html
|
||||
rm $i/tutorial_test.html
|
||||
# echo copied
|
||||
|
||||
#cleanup
|
||||
rm -r html
|
||||
# echo cleaned
|
||||
done
|
||||
|
||||
#cleanup
|
||||
rm single_tut.txt
|
||||
|
||||
@ -1,14 +1,5 @@
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p></td>
|
||||
</tr>
|
||||
</table>
|
||||
<div align="right"><br />
|
||||
<a href="http://validator.w3.org/check?uri=referer" target="_blank"><img src="images/general/valid-xhtml10.png" alt="Valid XHTML 1.0!" width="88" height="31" border="0" /></a>
|
||||
<a href="http://jigsaw.w3.org/css-validator/" target="_blank"><img src="images/general/vcss.gif" alt="Valid CSS!" width="88" height="31" border="0" /></a></div>
|
||||
</div>
|
||||
<p class="copyrighttext"><br />
|
||||
Irrlicht Engine and Irrlicht Engine webpage © 2003-2010 by Nikolaus Gebhardt</p>
|
||||
<!-- HTML footer for doxygen 1.8.13-->
|
||||
<!-- start footer part -->
|
||||
<p> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,52 +1,228 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<html>
|
||||
<head>
|
||||
<title>Irrlicht Engine - A free open source 3d engine</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||||
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
|
||||
<link rel="stylesheet" href="doxygen.css" type="text/css" />
|
||||
<link rel="stylesheet" href="style.css" type="text/css" />
|
||||
<!-- (c) 2005-2010 by N.Gebhardt -->
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<!-- Wanted to avoid copying .css to each folder, so copied default .css from doxyen in here, kicked out most stuff we don't need for examples and modified some a little bit.
|
||||
Target was having a single html in each example folder which is created from the main.cpp files and needs no files besides some images below media folder.
|
||||
Feel free to improve :)
|
||||
-->
|
||||
<style>
|
||||
body, table, div, p, dl {
|
||||
font: 400 14px/22px;
|
||||
}
|
||||
|
||||
body {
|
||||
background-color: #F0F0F0;
|
||||
color: black;
|
||||
margin-left: 5%;
|
||||
margin-right: 5%;
|
||||
}
|
||||
|
||||
p.reference, p.definition {
|
||||
font: 400 14px/22px;
|
||||
}
|
||||
|
||||
.title {
|
||||
font: 400 14px/28px;
|
||||
font-size: 150%;
|
||||
font-weight: bold;
|
||||
margin: 10px 2px;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
-webkit-transition: text-shadow 0.5s linear;
|
||||
-moz-transition: text-shadow 0.5s linear;
|
||||
-ms-transition: text-shadow 0.5s linear;
|
||||
-o-transition: text-shadow 0.5s linear;
|
||||
transition: text-shadow 0.5s linear;
|
||||
margin-right: 15px;
|
||||
}
|
||||
|
||||
caption {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h3.version {
|
||||
font-size: 90%;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #3D578C;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.contents a:visited {
|
||||
color: #4665A2;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a.el {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
a.code, a.code:visited, a.line, a.line:visited {
|
||||
color: #4665A2;
|
||||
}
|
||||
|
||||
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
|
||||
color: #4665A2;
|
||||
}
|
||||
|
||||
pre.fragment {
|
||||
border: 1px solid #C4CFE5;
|
||||
background-color: #FBFCFD;
|
||||
padding: 4px 6px;
|
||||
margin: 4px 8px 4px 2px;
|
||||
overflow: auto;
|
||||
word-wrap: break-word;
|
||||
font-size: 9pt;
|
||||
line-height: 125%;
|
||||
font-family: monospace, fixed;
|
||||
font-size: 105%;
|
||||
}
|
||||
|
||||
div.fragment {
|
||||
padding: 0px;
|
||||
margin: 4px 8px 4px 2px;
|
||||
background-color: #FBFCFD;
|
||||
border: 1px solid #C4CFE5;
|
||||
}
|
||||
|
||||
div.line {
|
||||
font-family: monospace, fixed;
|
||||
font-size: 13px;
|
||||
min-height: 13px;
|
||||
line-height: 1.0;
|
||||
text-wrap: unrestricted;
|
||||
white-space: -moz-pre-wrap; /* Moz */
|
||||
white-space: -pre-wrap; /* Opera 4-6 */
|
||||
white-space: -o-pre-wrap; /* Opera 7 */
|
||||
white-space: pre-wrap; /* CSS3 */
|
||||
word-wrap: break-word; /* IE 5.5+ */
|
||||
text-indent: -53px;
|
||||
padding-left: 53px;
|
||||
padding-bottom: 0px;
|
||||
margin: 0px;
|
||||
-webkit-transition-property: background-color, box-shadow;
|
||||
-webkit-transition-duration: 0.5s;
|
||||
-moz-transition-property: background-color, box-shadow;
|
||||
-moz-transition-duration: 0.5s;
|
||||
-ms-transition-property: background-color, box-shadow;
|
||||
-ms-transition-duration: 0.5s;
|
||||
-o-transition-property: background-color, box-shadow;
|
||||
-o-transition-duration: 0.5s;
|
||||
transition-property: background-color, box-shadow;
|
||||
transition-duration: 0.5s;
|
||||
}
|
||||
|
||||
div.contents {
|
||||
margin-top: 10px;
|
||||
margin-left: 12px;
|
||||
margin-right: 8px;
|
||||
}
|
||||
|
||||
div.center {
|
||||
text-align: center;
|
||||
margin-top: 0px;
|
||||
margin-bottom: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
div.center img {
|
||||
border: 0px;
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
blockquote {
|
||||
background-color: #F7F8FB;
|
||||
border-left: 2px solid #9CAFD4;
|
||||
margin: 0 24px 0 4px;
|
||||
padding: 0 12px 0 16px;
|
||||
}
|
||||
|
||||
hr {
|
||||
height: 0px;
|
||||
border: none;
|
||||
border-top: 1px solid #4A6AAA;
|
||||
}
|
||||
|
||||
address {
|
||||
font-style: normal;
|
||||
color: #2A3D61;
|
||||
}
|
||||
|
||||
div.header {
|
||||
background-image:url('nav_h.png');
|
||||
background-repeat:repeat-x;
|
||||
background-color: #F9FAFC;
|
||||
margin: 0px;
|
||||
border-bottom: 1px solid #C4CFE5;
|
||||
}
|
||||
|
||||
div.headertitle {
|
||||
padding: 5px 5px 5px 10px;
|
||||
}
|
||||
|
||||
.image {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.caption {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.zoom {
|
||||
border: 1px solid #90A5CE;
|
||||
}
|
||||
|
||||
tr.heading h2 {
|
||||
margin-top: 12px;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
</style>
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div align="center"><br/>
|
||||
<table cellspacing="0" class="main" >
|
||||
<tr>
|
||||
<td colspan="2" class="logobar" ><img alt="Irrlicht Engine logo" src="images/general/irrlichtlogo.gif" width="233" height="60" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" class="linkbar" ><a href="index.html">Home</a> | <a href="phpBB2/index.php">Forum</a>
|
||||
| <a href="docu/index.html" target="_blank">API</a> | <a href="http://www.google.com/custom?domains=irrlicht.sourceforge.net&sitesearch=irrlicht.sourceforge.net" target="_blank">Search</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="sidebar"> <div class="sidebarentry">
|
||||
<p class="sideBarTitle">Engine</p>
|
||||
<a href="index.html">News</a> <a href="features.html">Features</a> <a href="screenshots.html">Screenshots</a>
|
||||
<a href="downloads.html">Downloads</a>
|
||||
<a href="development.html">Development</a>
|
||||
<a href="toolset.html">Toolset</a>
|
||||
</div>
|
||||
<div class="sidebarentry">
|
||||
<p class="sideBarTitle">Documentation</p>
|
||||
<a href="faq.html">FAQ</a> <a href="docu/index.html" target="_blank">API</a>
|
||||
<a href="docu.net/index.html" target="_blank">API.NET</a> <a href="tutorials.html">Tutorials</a>
|
||||
<a href="license.html">License</a> <a href="newsarchive.html">News-Archive</a>
|
||||
<a href="http://www.irrlicht3d.org/wiki" target="_blank">Wiki</a> </div>
|
||||
<div class="sidebarentry">
|
||||
<p class="sideBarTitle">Sourceforge</p>
|
||||
<a href="http://sourceforge.net/projects/irrlicht/">Project Page</a>
|
||||
<a href="phpBB2/index.php">Forums</a>
|
||||
<a href="shirts.html">Shirts</a> </div>
|
||||
<div class="sidebarentry">
|
||||
<p class="sideBarTitle">Contact</p>
|
||||
<a href="links.html">Links</a> <a href="author.html">Author</a> <a href="impressum.html">Impressum</a> </div>
|
||||
<p><a href="http://irrlicht.sourceforge.net"><br />
|
||||
<img alt="Irrlicht Engine logo button" src="images/general/irrlicht.png" width="88" height="31" border="0" /></a></p>
|
||||
<p><a href="http://sourceforge.net"> <img src="http://sourceforge.net/sflogo.php?group_id=74339&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a></p>
|
||||
<p> <a href="http://opensource.org/" target="_blank"><img alt="OSI Certified logo" src="images/general/osi-certified-72x60-t.png" width="72" height="60" border="0" /></a>
|
||||
</p>
|
||||
<p> </p></td>
|
||||
<td class="mainframe" > <table class="newsbox" >
|
||||
<tr>
|
||||
<td class="newscontent">
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
|
||||
<!--END TITLEAREA-->
|
||||
<!-- end header part -->
|
||||
|
||||
Reference in New Issue
Block a user