diff --git a/Doxyfile b/Doxyfile index 6ea4977f..fbb573bc 100644 --- a/Doxyfile +++ b/Doxyfile @@ -830,13 +830,13 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # 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 # each generated HTML page. If it is left blank doxygen will generate a # 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 # 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 # 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. # Doxygen will adjust the colors in the stylesheet and background images diff --git a/documentation/img/metalsvm_stack.jpg b/documentation/img/metalsvm_stack.jpg index 7b47ad79..1bb53e85 100644 Binary files a/documentation/img/metalsvm_stack.jpg and b/documentation/img/metalsvm_stack.jpg differ diff --git a/documentation/text/compilation.dox b/documentation/text/compilation.dox index 1222228f..61739023 100644 --- a/documentation/text/compilation.dox +++ b/documentation/text/compilation.dox @@ -73,7 +73,7 @@ READELF_FOR_TARGET=i386-unknown-linux-gnu-readelf \endverbatim #define COPPERRIDGE #define MS_BAREMETAL //#define GORY -#define SHMADD +//#define SHMADD #define SHMDBG //#define SHMADD_CACHEABLE \endverbatim * -# 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: * \verbatim$ ./bootinfo.sh 0x01000000 initrd.img 2 533 0 1 > scc_bootinfo.asm \endverbatim * 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 * -# 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: diff --git a/documentation/tmpl/footer.html b/documentation/tmpl/footer.html index 3fda0093..c93cb561 100644 --- a/documentation/tmpl/footer.html +++ b/documentation/tmpl/footer.html @@ -1,5 +1,5 @@ -
  • Generated on $datetime for $projectname by +
  • $generatedby doxygen $doxygenversion
    • @@ -7,7 +7,10 @@
    -Generated on $datetime for $projectname by doxygen $doxygenversion
    +$generatedby   +doxygen + $doxygenversion + diff --git a/documentation/tmpl/header.html b/documentation/tmpl/header.html index 97a54784..7889340f 100644 --- a/documentation/tmpl/header.html +++ b/documentation/tmpl/header.html @@ -2,15 +2,17 @@ -$title +$projectname: $title +$title - + $treeview $search $mathjax
    +
    @@ -22,7 +24,6 @@ $mathjax -
    $projectname diff --git a/documentation/tmpl/layout.xml b/documentation/tmpl/layout.xml index 6794c866..b27abc1d 100644 --- a/documentation/tmpl/layout.xml +++ b/documentation/tmpl/layout.xml @@ -64,6 +64,7 @@ + @@ -91,6 +92,7 @@ + @@ -118,6 +120,7 @@ + diff --git a/documentation/tmpl/stylesheet.css b/documentation/tmpl/stylesheet.css index 9564fb02..016d9d71 100644 --- a/documentation/tmpl/stylesheet.css +++ b/documentation/tmpl/stylesheet.css @@ -72,8 +72,6 @@ div.qindex, div.navtab{ background-color: #EBEFF6; border: 1px solid #A3B4D7; text-align: center; - margin: 2px; - padding: 2px; } div.qindex, div.navpath { @@ -183,15 +181,15 @@ div.groupText { } body { - background: white; + background-color: white; color: black; margin: 0; } div.contents { margin-top: 10px; - margin-left: 10px; - margin-right: 5px; + margin-left: 8px; + margin-right: 8px; } td.indexkey { @@ -414,7 +412,7 @@ table.memberdecls { margin-left: 6px; } -.memproto { +.memproto, dl.reflist dt { border-top: 1px solid #A8B8D9; border-left: 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-left: 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)); } +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + .paramkey { text-align: right; } @@ -622,6 +629,58 @@ table.doxtable th { 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 { top: 0px; left: 10px; @@ -701,6 +760,7 @@ div.summary a div.ingroups { + margin-left: 5px; font-size: 8pt; padding-left: 5px; width: 50%; @@ -723,7 +783,7 @@ div.header div.headertitle { - padding: 5px 5px 5px 10px; + padding: 5px 5px 5px 7px; } dl @@ -847,6 +907,57 @@ dl.bug 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 { width: 800px;