Added new doxygen templates and limited basic to core (nw)

2025-04-16 21:44:32 +03:00 · 2015-11-16 10:30:51 +01:00 · 2015-11-16 10:30:51 +01:00 · cabec7b81c
commit cabec7b81c
parent a044a3309f
8 changed files with 745 additions and 282 deletions
--- a/.gitignore
+++ b/.gitignore
@ -12,6 +12,7 @@
 !/scripts/
 !/src/
 !/tests/
+!/doxygen/
 !/web/
 !/.gitattributes
 !/.gitignore
--- a/doxygen/README.md
+++ b/doxygen/README.md
@ -0,0 +1,8 @@
+What is MAME?
+=============
+
+MAME stands for Multiple Arcade Machine Emulator.
+
+MAME's purpose is to preserve decades of video-game history. As gaming technology continues to rush forward, MAME prevents these important "vintage" games from being lost and forgotten. This is achieved by documenting the hardware and how it functions. The source code to MAME serves as this documentation. The fact that the games are playable serves primarily to validate the accuracy of the documentation (how else can you prove that you have recreated the hardware faithfully?).
+
+
--- a/doxygen/doxy-boot.js
+++ b/doxygen/doxy-boot.js
@ -0,0 +1,123 @@
+$( document ).ready(function() {
+
+    $("div.headertitle").addClass("page-header");
+    $("div.title").addClass("h1");
+
+    $('li > a[href="index.html"] > span').before("<i class='fa fa-cog'></i> ");
+    $('li > a[href="modules.html"] > span').before("<i class='fa fa-square'></i> ");
+    $('li > a[href="namespaces.html"] > span').before("<i class='fa fa-bars'></i> ");
+    $('li > a[href="annotated.html"] > span').before("<i class='fa fa-list-ul'></i> ");
+    $('li > a[href="classes.html"] > span').before("<i class='fa fa-book'></i> ");
+    $('li > a[href="inherits.html"] > span').before("<i class='fa fa-sitemap'></i> ");
+    $('li > a[href="functions.html"] > span').before("<i class='fa fa-list'></i> ");
+    $('li > a[href="functions_func.html"] > span').before("<i class='fa fa-list'></i> ");
+    $('li > a[href="functions_vars.html"] > span').before("<i class='fa fa-list'></i> ");
+    $('li > a[href="functions_enum.html"] > span').before("<i class='fa fa-list'></i> ");
+    $('li > a[href="functions_eval.html"] > span').before("<i class='fa fa-list'></i> ");
+    $('img[src="ftv2ns.png"]').replaceWith('<span class="label label-danger">N</span> ');
+    $('img[src="ftv2cl.png"]').replaceWith('<span class="label label-danger">C</span> ');
+
+    $("div#navrow1 > ul.tablist").addClass("nav nav-pills");
+    $("div#navrow1 > ul.tablist").addClass("nav-justified");
+    $("div#navrow2 > ul.tablist").addClass("nav nav-tabs");
+    $("div#navrow3 > ul.tablist").addClass("pager");
+    $("div#navrow4 > ul.tablist").addClass("pagination pagination-sm center");
+    $("div#navrow5 > ul.tablist").addClass("pagination pagination-sm pagination-centered");
+    $("ul.tablist").css("margin-top", "0.5em");
+    $("ul.tablist").css("margin-bottom", "0.5em");
+    $("li.current").addClass("active");
+    $("iframe").attr("scrolling", "yes");
+
+    $("#nav-path > ul").addClass("breadcrumb");
+
+    $("table.params").addClass("table");
+    $("div.ingroups").wrapInner("<small></small>");
+    $("div.levels").css("margin", "0.5em");
+    $("div.levels > span").addClass("btn btn-default btn-xs");
+    $("div.levels > span").css("margin-right", "0.25em");
+
+    $("table.directory").addClass("table table-striped");
+    $("div.summary > a").addClass("btn btn-default btn-xs");
+    $("table.fieldtable").addClass("table");
+    $(".fragment").addClass("well");
+    $(".memitem").addClass("panel panel-default");
+    $(".memproto").addClass("panel-heading");
+    $(".memdoc").addClass("panel-body");
+    $("span.mlabel").addClass("label label-info");
+
+    $("table.memberdecls").addClass("table");
+    $("[class^=memitem]").addClass("active");
+
+    $("div.ah").addClass("btn btn-default");
+    $("span.mlabels").addClass("pull-right");
+    $("table.mlabels").css("width", "100%")
+    $("td.mlabels-right").addClass("pull-right");
+
+    $("div.ttc").addClass("panel panel-primary");
+    $("div.ttname").addClass("panel-heading");
+    $("div.ttname a").css("color", 'white');
+    $("div.ttdef,div.ttdoc,div.ttdeci").addClass("panel-body");
+
+    $('#MSearchBox').parent().remove();
+
+    //$('div.fragment.well div.line:first').css('margin-top', '15px');
+    //$('div.fragment.well div.line:last').css('margin-bottom', '15px');
+
+    $('table.doxtable').removeClass('doxtable').addClass('table table-striped table-bordered').each(function(){
+	$(this).prepend('<thead></thead>');
+	$(this).find('tbody > tr:first').prependTo($(this).find('thead'));
+
+	$(this).find('td > span.success').parent().addClass('success');
+	$(this).find('td > span.warning').parent().addClass('warning');
+	$(this).find('td > span.danger').parent().addClass('danger');
+    });
+
+    if($('div.fragment.well div.ttc').length > 0)
+    {
+        $('div.fragment.well div.line:first').parent().removeClass('fragment well');
+    }
+
+    $('table.memberdecls').find('.memItemRight').each(function(){
+        $(this).contents().appendTo($(this).siblings('.memItemLeft'));
+        $(this).siblings('.memItemLeft').attr('align', 'left');
+    });
+
+    function getOriginalWidthOfImg(img_element) {
+	var t = new Image();
+	t.src = (img_element.getAttribute ? img_element.getAttribute("src") : false) || img_element.src;
+	return t.width;
+    }
+
+    $('div.dyncontent').find('img').each(function(){
+	if(getOriginalWidthOfImg($(this)[0]) > $('#content>div.container').width())
+	    $(this).css('width', '100%');
+    });
+
+    $(".memitem").removeClass('memitem');
+    $(".memproto").removeClass('memproto');
+    $(".memdoc").removeClass('memdoc');
+    $("span.mlabel").removeClass('mlabel');
+    $("table.memberdecls").removeClass('memberdecls');
+    $("[class^=memitem]").removeClass('memitem');
+    $("span.mlabels").removeClass('mlabels');
+    $("table.mlabels").removeClass('mlabels');
+    $("td.mlabels-right").removeClass('mlabels-right');
+    $(".navpath").removeClass('navpath');
+    $("li.navelem").removeClass('navelem');
+    $("a.el").removeClass('el');
+    $("div.ah").removeClass('ah');
+    $("div.header").removeClass("header");
+
+    $('.mdescLeft').each(function(){
+	if($(this).html()=="&nbsp;") {
+	    $(this).siblings('.mdescRight').attr('colspan', 2);
+	    $(this).remove();
+	}
+    });
+    $('td.memItemLeft').each(function(){
+	if($(this).siblings('.memItemRight').html()=="") {
+	    $(this).attr('colspan', 2);
+	    $(this).siblings('.memItemRight').remove();
+	}
+    });
+});
--- a/doxygen/doxygen.config
+++ b/doxygen/doxygen.config
--- a/doxygen/footer.html
+++ b/doxygen/footer.html
@ -0,0 +1,31 @@
+<!-- HTML footer for doxygen 1.8.8-->
+<!-- start footer part -->
+
+<!--BEGIN GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer">$generatedby
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
+  </ul>
+</div>
+<!--END GENERATE_TREEVIEW-->
+</div>
+<!--BEGIN !GENERATE_TREEVIEW-->
+<hr class="footer"/><address class="footer"><small>
+$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-->
+
+<a href="https://github.com/mamedev/mame">
+  <img style="position: absolute; top: 0; right: 0; border: 0;"
+       src="https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67"
+       alt="Fork me on GitHub"
+       data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"/>
+</a>
+
+</body>
+</html>
--- a/doxygen/header.html
+++ b/doxygen/header.html
@ -0,0 +1,46 @@
+<!-- HTML header for doxygen 1.8.8-->
+<!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">
+    <head>
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <!-- For Mobile Devices -->
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+
+        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+        <meta name="generator" content="Doxygen $doxygenversion"/>
+
+        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
+        <script type="text/javascript" src="http://stevenbenner.github.io/jquery-powertip/scripts/jquery.powertip.js"></script>
+
+        <!--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"/>-->
+        <script type="text/javascript" src="$relpath^dynsections.js"></script>
+        $treeview
+        $search
+
+        <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+
+        <link rel="stylesheet" href="http://bootswatch.com/journal/bootstrap.min.css">
+        <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
+        <script type="text/javascript" src="$relpath^doxy-boot.js"></script>
+
+        $extrastylesheet
+
+    </head>
+      <body>
+        <nav class="navbar navbar-default" role="navigation">
+            <div class="container">
+                <div class="navbar-header">
+                    <span class="navbar-brand">$projectname $projectnumber</span>
+                </div>
+                <div class="navbar-header">
+                  <span class="navbar-brand brief">$projectbrief</span>
+                </div>
+            </div>
+        </nav>
+
+        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+            <div class="content" id="content">
+
+<!-- end header part -->
--- a/doxygen/style.css
+++ b/doxygen/style.css
@ -0,0 +1,367 @@
+/* -- customizing doxygen.css stuff -- */
+
+.mdescLeft, .mdescRight {
+    color: #777;
+}
+
+dl.todo, dl.note {
+    padding-left: 10px;
+}
+
+.memSeparator, .table, .table>tbody>.heading>td {
+    border: 0
+}
+.table > tbody > tr > td.memSeparator {
+    line-height: 0px;
+}
+.table > tbody > tr > td {
+    border: 0px;
+}
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+    background-color: #fff;
+    border: none;
+    margin: 4px;
+    padding: 1px 0 0 8px;
+}
+
+.table > tbody > tr.active > .memTemplParams {
+    line-height: 14px;
+    background-color: #fff;
+    margin: 0px;
+}
+
+.table > tbody > tr.active {
+    border: 1px solid #DDD;
+    border-radius: 4px;
+}
+
+.label {
+    margin-right: 0.5em;
+}
+
+/* -- customizing boostrap.css stuff -- */
+
+.navbar {
+    margin-bottom: 0px;
+}
+.navbar-default .navbar-brand {
+    background: none;
+}
+.navbar-default .navbar-brand.brief {
+    color: #888;
+}
+
+.pagination {
+    text-align: center;
+    width: 100%;
+}
+
+.pagination > li {
+    float:none;
+    display:inline-block;
+    margin: 0
+}
+
+.nav-tabs > li {
+    float:none;
+    display:inline-block;
+    *display:inline; /* ie7 fix */
+     zoom:1; /* hasLayout ie7 trigger */
+}
+
+.nav-tabs {
+    text-align:center;
+}
+
+.nav > li {
+    padding-right: 0.5em;
+}
+
+.h1 { font-size: 200%; line-height: 1.3;  }
+h3 { font-size: 140%; line-height: 1.3; }
+
+.paramname {
+    padding-right: 20px;
+}
+
+.tparams > tbody, .params > tbody { vertical-align: top; }
+dt, dd { line-height: 26px; }
+dt {  color: #354C7B; }
+body, table, table.directory, div, p, dl {
+    line-height: 26px;
+    font: 400 16px/26px Roboto,sans-serif;
+}
+dl.section dd { margin-bottom: 0; }
+
+h1, .h1, h2, .h2, h3, .h3{
+    font-weight: 200 !important;
+}
+
+#navrow1 {
+    border-bottom: 2px solid #EEEEEE;
+}
+
+#navrow2, #navrow3, #navrow4, #navrow5 {
+    border-bottom: 0px solid #EEEEEE;
+}
+
+.adjust-right {
+    margin-left: 30px !important;
+    font-size: 1.15em !important;
+}
+.navbar{
+    border: 0px solid #222 !important;
+}
+
+
+/* Sticky footer styles
+-------------------------------------------------- */
+html,
+body {
+    height: 100%;
+    /* The html and body elements cannot have any padding or margin. */
+}
+
+/* Wrapper for page content to push down footer */
+#wrap {
+    min-height: 100%;
+    height: auto;
+    /* Negative indent footer by its height */
+    margin: 0 auto -60px;
+    /* Pad bottom by footer height */
+    padding: 0 0 60px;
+}
+
+/* Set the fixed height of the footer here */
+#footer {
+    font-size: 0.9em;
+    padding: 8px 0px;
+    background-color: #f5f5f5;
+}
+
+.footer-row {
+    line-height: 44px;
+}
+
+#footer > .container {
+    padding-left: 15px;
+    padding-right: 15px;
+}
+
+.footer-follow-icon {
+    margin-left: 3px;
+    text-decoration: none !important;
+}
+
+.footer-follow-icon img {
+    width: 20px;
+}
+
+.footer-link {
+    padding-top: 5px;
+    display: inline-block;
+    color: #999999;
+    text-decoration: none;
+}
+
+.footer-copyright {
+    text-align: center;
+}
+
+
+@media (min-width: 992px) {
+    .footer-row {
+        text-align: left;
+    }
+
+    .footer-icons {
+        text-align: right;
+    }
+}
+@media (max-width: 991px) {
+    .footer-row {
+        text-align: center;
+    }
+
+    .footer-icons {
+        text-align: center;
+    }
+}
+
+/* DOXYGEN Code Styles
+----------------------------------- */
+
+
+a.qindex {
+    font-weight: bold;
+}
+
+a.qindexHL {
+    font-weight: bold;
+    background-color: #9CAFD4;
+    color: #ffffff;
+    border: 1px double #869DCA;
+}
+
+.contents a.qindexHL:visited {
+    color: #ffffff;
+}
+
+a.code, a.code:visited, a.line, a.line:visited {
+    color: #4665A2;
+}
+
+a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
+    color: #4665A2;
+}
+
+/* @end */
+
+dl.el {
+    margin-left: -1cm;
+}
+
+pre.fragment {
+    border: 1px solid #C4CFE5;
+    background-color: #FBFCFD;
+    padding: 4px 6px;
+    margin: 4px 8px 4px 2px;
+    overflow: auto;
+    word-wrap: break-word;
+    line-height: 125%;
+    font-family: monospace, fixed;
+    font-size: 105%;
+}
+
+div.fragment {
+    margin: 8px 8px 8px 8px;
+    border: 0px solid #C4CFE5;
+    background-color: #F6F7F8;
+    box-shadow: none;
+    padding: 15px;
+    padding-bottom: 10px;
+}
+
+div.line {
+    font-family: monospace, fixed;
+    font-size: 15px;
+    min-height: 20px;
+    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;
+    vertical-align: middle;
+    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.line.glow {
+    background-color: cyan;
+    box-shadow: 0 0 10px cyan;
+}
+
+
+span.lineno {
+    padding-right: 5px;
+    text-align: right;
+    border-right: 2px solid #adc;
+    background-color: transparent;
+    white-space: pre;
+}
+span.lineno a {
+    background-color: #eee;
+}
+
+span.lineno a:hover {
+    background-color: #C8C8C8;
+}
+
+div.groupHeader {
+    margin-left: 16px;
+    margin-top: 12px;
+    font-weight: bold;
+}
+
+div.groupText {
+    margin-left: 16px;
+    font-style: italic;
+}
+
+/* @group Code Colorization */
+
+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
+}
+
+span.vhdldigit {
+    color: #ff00ff
+}
+
+span.vhdlchar {
+    color: #000000
+}
+
+span.vhdlkeyword {
+    color: #700070
+}
+
+span.vhdllogic {
+    color: #ff0000
+}
+
+blockquote {
+    background-color: #F7F8FB;
+    border-left: 2px solid #9CAFD4;
+    margin: 0 24px 0 4px;
+    padding: 0 12px 0 16px;
+}
+
+div.summary {
+    float: right;
+    font-size: 8pt;
+    padding-right: 5px;
+    width: 80%;
+    text-align: right;
+}
--- a/2
+++ b/2
@ -1190,7 +1190,7 @@ endif

 doxygen:
 	@echo Generate Doxygen documentation
-	doxygen mame.doxygen
+	doxygen doxygen/doxygen.config

 #-------------------------------------------------
 # CppCheck analysis