stv0g/metalsvm
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Template-fix

Browse source 
Fixed the doxygen HTML-documentation template. This feature seems to be                               quite new, so they will change things from time to time...

Works with doxygen 1.7.5.1

Fixed two spots where Stefan fixed the text in the original article from L2P.
This commit is contained in:
Jacek Galowicz 2011-11-09 10:47:41 +01:00
parent 7db55b481d
commit 75263f85d6
7 changed files with 136 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Doxyfile
View file

@ -830,13 +830,13 @@ HTML_FILE_EXTENSION = .html
# each generated HTML page. If it is left blank doxygen will generate a # each generated HTML page. If it is left blank doxygen will generate a
# standard header. # standard header.
HTML_HEADER = ./documentation/tmpl/header.html HTML_HEADER = documentation/tmpl/header.html
# The HTML_FOOTER tag can be used to specify a personal HTML footer for # The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a # each generated HTML page. If it is left blank doxygen will generate a
# standard footer. # standard footer.
HTML_FOOTER = ./documentation/tmpl/footer.html HTML_FOOTER = documentation/tmpl/footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to # style sheet that is used by each HTML page. It can be used to
@ -845,7 +845,7 @@ HTML_FOOTER = ./documentation/tmpl/footer.html
# the style sheet file to the HTML output directory, so don't put your own # the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased! # stylesheet in the HTML output directory as well, or it will be erased!
HTML_STYLESHEET = ./documentation/tmpl/stylesheet.css HTML_STYLESHEET = documentation/tmpl/stylesheet.css
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the stylesheet and background images # Doxygen will adjust the colors in the stylesheet and background images

BIN
documentation/img/metalsvm_stack.jpg
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 94 KiB

4
documentation/text/compilation.dox
View file

@ -73,7 +73,7 @@ READELF_FOR_TARGET=i386-unknown-linux-gnu-readelf \endverbatim
#define COPPERRIDGE #define COPPERRIDGE
#define MS_BAREMETAL #define MS_BAREMETAL
//#define GORY //#define GORY
#define SHMADD //#define SHMADD
#define SHMDBG #define SHMDBG
//#define SHMADD_CACHEABLE \endverbatim //#define SHMADD_CACHEABLE \endverbatim
* -# There is only one core per tile, so it is adequate to reduce overhead by disabling SMP in MetalSVM: * -# There is only one core per tile, so it is adequate to reduce overhead by disabling SMP in MetalSVM:
@ -101,7 +101,7 @@ $ make SCC \endverbatim
* The following example generates the \c scc_bootinfo.asm file needed for use of the cores 0 and 1: * The following example generates the \c scc_bootinfo.asm file needed for use of the cores 0 and 1:
* \verbatim$ ./bootinfo.sh 0x01000000 initrd.img 2 533 0 1 > scc_bootinfo.asm \endverbatim * \verbatim$ ./bootinfo.sh 0x01000000 initrd.img 2 533 0 1 > scc_bootinfo.asm \endverbatim
* Parameters describe the following: * Parameters describe the following:
* -# First parameter describes the address at which the initrd shall be located at later * -# First parameter describes the address at which the initrd shall be located at later (You will not need to change this: 0x00100000)
* -# Second is path to the initrd image file * -# Second is path to the initrd image file
* -# The other parameters are analogous to RCCE-App-parameters. This example starts MetalSVM on cores 0 and 1, clocked with 533MHz. * -# The other parameters are analogous to RCCE-App-parameters. This example starts MetalSVM on cores 0 and 1, clocked with 533MHz.
* -# Now the file \c metalsvm.mt has to be edited. It defines the layout of the memory image (Where the kernels will be located in the memory later). For the example from above it looks like the following: * -# Now the file \c metalsvm.mt has to be edited. It defines the layout of the memory image (Where the kernels will be located in the memory later). For the example from above it looks like the following:

7
documentation/tmpl/footer.html
View file

@ -1,5 +1,5 @@
<!--BEGIN GENERATE_TREEVIEW--> <!--BEGIN GENERATE_TREEVIEW-->
<li class="footer">Generated on $datetime for $projectname by <li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html"> <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion </li> <img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
</ul> </ul>
@ -7,7 +7,10 @@
<!--END GENERATE_TREEVIEW--> <!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW--> <!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small> <hr class="footer"/><address class="footer"><small>
Generated on $datetime for $projectname by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="$relpath$doxygen.png" alt="doxygen"/></a> $doxygenversion</small></address> $generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath$doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small></address>
<!--END !GENERATE_TREEVIEW--> <!--END !GENERATE_TREEVIEW-->
</body> </body>
</html> </html>

7
documentation/tmpl/header.html
View file

@ -2,15 +2,17 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>$title</title> <!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/> <link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
<link href="$relpath$stylesheet.css" rel="stylesheet" type="text/css" /> <link href="stylesheet.css" rel="stylesheet" type="text/css" />
$treeview $treeview
$search $search
$mathjax $mathjax
</head> </head>
<body> <body>
<div id="top"><!-- do not remove this div! --> <div id="top"><!-- do not remove this div! -->
<!--BEGIN TITLEAREA--> <!--BEGIN TITLEAREA-->
<div id="titlearea"> <div id="titlearea">
<table cellspacing="0" cellpadding="0"> <table cellspacing="0" cellpadding="0">
@ -22,7 +24,6 @@ $mathjax
<div id="rwthlogo"><img src="../img/rwth_logo.gif" alt="RWTH Aachen University" /></div> <div id="rwthlogo"><img src="../img/rwth_logo.gif" alt="RWTH Aachen University" /></div>
</td> </td>
<!--END PROJECT_LOGO--> <!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME--> <!--BEGIN PROJECT_NAME-->
<td style="padding-left: 0.5em;"> <td style="padding-left: 0.5em;">
<div id="projectname">$projectname <div id="projectname">$projectname

3
documentation/tmpl/layout.xml
View file

@ -64,6 +64,7 @@
</memberdecl> </memberdecl>
<detaileddescription title=""/> <detaileddescription title=""/>
<memberdef> <memberdef>
<inlineclasses title=""/>
<typedefs title=""/> <typedefs title=""/>
<enums title=""/> <enums title=""/>
<constructors title=""/> <constructors title=""/>
@ -91,6 +92,7 @@
</memberdecl> </memberdecl>
<detaileddescription title=""/> <detaileddescription title=""/>
<memberdef> <memberdef>
<inlineclasses title=""/>
<typedefs title=""/> <typedefs title=""/>
<enums title=""/> <enums title=""/>
<functions title=""/> <functions title=""/>
@ -118,6 +120,7 @@
</memberdecl> </memberdecl>
<detaileddescription title=""/> <detaileddescription title=""/>
<memberdef> <memberdef>
<inlineclasses title=""/>
<defines title=""/> <defines title=""/>
<typedefs title=""/> <typedefs title=""/>
<enums title=""/> <enums title=""/>

127
documentation/tmpl/stylesheet.css
View file

@ -72,8 +72,6 @@ div.qindex, div.navtab{
background-color: #EBEFF6; background-color: #EBEFF6;
border: 1px solid #A3B4D7; border: 1px solid #A3B4D7;
text-align: center; text-align: center;
margin: 2px;
padding: 2px;
} }
div.qindex, div.navpath { div.qindex, div.navpath {
@ -183,15 +181,15 @@ div.groupText {
} }
body { body {
background: white; background-color: white;
color: black; color: black;
margin: 0; margin: 0;
} }
div.contents { div.contents {
margin-top: 10px; margin-top: 10px;
margin-left: 10px; margin-left: 8px;
margin-right: 5px; margin-right: 8px;
} }
td.indexkey { td.indexkey {
@ -414,7 +412,7 @@ table.memberdecls {
margin-left: 6px; margin-left: 6px;
} }
.memproto { .memproto, dl.reflist dt {
border-top: 1px solid #A8B8D9; border-top: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9; border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9; border-right: 1px solid #A8B8D9;
@ -440,7 +438,7 @@ table.memberdecls {
} }
.memdoc { .memdoc, dl.reflist dd {
border-bottom: 1px solid #A8B8D9; border-bottom: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9; border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9; border-right: 1px solid #A8B8D9;
@ -463,6 +461,15 @@ table.memberdecls {
background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7));
} }
dl.reflist dt {
padding: 5px;
}
dl.reflist dd {
margin: 0px 0px 10px 0px;
padding: 5px;
}
.paramkey { .paramkey {
text-align: right; text-align: right;
} }
@ -622,6 +629,58 @@ table.doxtable th {
text-align:left; text-align:left;
} }
table.fieldtable {
width: 100%;
margin-bottom: 10px;
border: 1px solid #A8B8D9;
border-spacing: 0px;
-moz-border-radius: 4px;
-webkit-border-radius: 4px;
border-radius: 4px;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
-webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname {
white-space: nowrap;
border-right: 1px solid #A8B8D9;
border-bottom: 1px solid #A8B8D9;
vertical-align: top;
}
.fieldtable td.fielddoc {
border-bottom: 1px solid #A8B8D9;
width: 100%;
}
.fieldtable tr:last-child td {
border-bottom: none;
}
.fieldtable th {
background-image:url('nav_f.png');
background-repeat:repeat-x;
background-color: #E2E8F2;
font-size: 90%;
color: #253555;
padding-bottom: 4px;
padding-top: 5px;
text-align:left;
-moz-border-radius-topleft: 4px;
-moz-border-radius-topright: 4px;
-webkit-border-top-left-radius: 4px;
-webkit-border-top-right-radius: 4px;
border-top-left-radius: 4px;
border-top-right-radius: 4px;
border-bottom: 1px solid #A8B8D9;
}
.tabsearch { .tabsearch {
top: 0px; top: 0px;
left: 10px; left: 10px;
@ -701,6 +760,7 @@ div.summary a
div.ingroups div.ingroups
{ {
margin-left: 5px;
font-size: 8pt; font-size: 8pt;
padding-left: 5px; padding-left: 5px;
width: 50%; width: 50%;
@ -723,7 +783,7 @@ div.header
div.headertitle div.headertitle
{ {
padding: 5px 5px 5px 10px; padding: 5px 5px 5px 7px;
} }
dl dl
@ -847,6 +907,57 @@ dl.bug
font-weight: bold; font-weight: bold;
} }
div.zoom
{
border: 1px solid #90A5CE;
}
dl.citelist {
margin-bottom:50px;
}
dl.citelist dt {
color:#334975;
float:left;
font-weight:bold;
margin-right:10px;
padding:5px;
}
dl.citelist dd {
margin:2px 0;
padding:5px 0;
}
@media print
{
#top { display: none; }
#side-nav { display: none; }
#nav-path { display: none; }
body { overflow:visible; }
h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
.summary { display: none; }
.memitem { page-break-inside: avoid; }
#doc-content
{
margin-left:0 !important;
height:auto !important;
width:auto !important;
overflow:inherit;
display:inline;
}
pre.fragment
{
overflow: visible;
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+ */
}
}
.textblock .textblock
{ {
width: 800px; width: 800px;