doxygen: Updated configuration to be based on up-to-date template, updated bootstrapped theme so it doesn't 404 (still won't work due to lack of support for jQuery smartmenus).

2024-11-16 07:48:32 +01:00 · 2021-09-08 00:04:42 +10:00 · 2021-09-08 00:04:42 +10:00 · 9dc47ef905
commit 9dc47ef905
parent 142f960238
5 changed files with 898 additions and 329 deletions
--- a/doxygen/doxy-boot.js
+++ b/doxygen/doxy-boot.js
@ -17,22 +17,16 @@ $( document ).ready(function() {
    $('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").addClass("nav nav-pills nav-justified");
    $("ul.tablist").css("margin-top", "0.5em");
    $("ul.tablist").css("margin-bottom", "0.5em");
-    $("ul.tablist").css("padding-right", "50px");
    $("li.current").addClass("active");
    $("iframe").attr("scrolling", "yes");

    $("#nav-path > ul").addClass("breadcrumb");

    $("table.params").addClass("table");
-    $("div.ingroups").wrapInner("<small></small>");
+    $("div.ingroups").wrapInner("<span class='text-nowrap'></span>");
    $("div.levels").css("margin", "0.5em");
    $("div.levels > span").addClass("btn btn-default btn-xs");
    $("div.levels > span").css("margin-right", "0.25em");
@ -59,19 +53,19 @@ $( document ).ready(function() {
    $("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', '2px');
+    $('div.fragment.well div.line:last').css('margin-bottom', '2px');

-    //$('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');
+	});

-    $('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)
    {
@ -83,42 +77,195 @@ $( document ).ready(function() {
        $(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%');
+    $('table.memberdecls').find('.memTemplItemRight').each(function(){
+        $(this).contents().appendTo($(this).siblings('.memTemplItemLeft'));
+        $(this).siblings('.memTemplItemLeft').attr('align', 'left');
    });

-    $(".memitem").removeClass('memitem');
+	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%');
+	});
+
+
+  /* responsive search box */
+  $('#MSearchBox').parent().remove();
+
+  var nav_container = $('<div class="row"></div>');
+  $('#navrow1').parent().prepend(nav_container);
+
+  var left_nav = $('<div class="col-md-9"></div>');
+  for (i = 0; i < 6; i++) {
+    var navrow = $('#navrow' + i + ' > ul.tablist').detach();
+    left_nav.append(navrow);
+    $('#navrow' + i).remove();
+  }
+  var right_nav = $('<div class="col-md-3"></div>').append('\
+    <div id="search-box" class="input-group">\
+      <div class="input-group-btn">\
+        <button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">\
+          <span class="glyphicon glyphicon-search"></span> <span class="caret"></span>\
+        </button>\
+        <ul class="dropdown-menu">\
+        </ul>\
+      </div>\
+      <button id="search-close" type="button" class="close" aria-label="Close"><span aria-hidden="true">&times;</span></button>\
+      <input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">\
+    </div>');
+  $(nav_container).append(left_nav);
+  $(nav_container).append(right_nav);
+
+  $('#MSearchSelectWindow .SelectionMark').remove();
+  var search_selectors = $('#MSearchSelectWindow .SelectItem');
+  for (var i = 0; i < search_selectors.length; i += 1) {
+    var element_a = $('<a href="#"></a>').text($(search_selectors[i]).text());
+
+    element_a.click(function(){
+      $('#search-box .dropdown-menu li').removeClass('active');
+      $(this).parent().addClass('active');
+      searchBox.OnSelectItem($('#search-box li a').index(this));
+      searchBox.Search();
+      return false;
+    });
+
+    var element = $('<li></li>').append(element_a);
+    $('#search-box .dropdown-menu').append(element);
+  }
+  $('#MSearchSelectWindow').remove();
+
+  $('#search-box .close').click(function (){
+    searchBox.CloseResultsWindow();
+  });
+
+  $('body').append('<div id="MSearchClose"></div>');
+  $('body').append('<div id="MSearchBox"></div>');
+  $('body').append('<div id="MSearchSelectWindow"></div>');
+
+  searchBox.searchLabel = '';
+  searchBox.DOMSearchField = function() {
+    return document.getElementById("search-field");
+  }
+  searchBox.DOMSearchClose = function(){
+    return document.getElementById("search-close");
+  }
+
+
+  /* search results */
+  var results_iframe = $('#MSearchResults').detach();
+  $('#MSearchResultsWindow')
+    .attr('id', 'search-results-window')
+    .addClass('panel panel-default')
+    .append(
+      '<div class="panel-heading">\
+        <h3 class="panel-title">Search Results</h3>\
+      </div>\
+      <div class="panel-body"></div>'
+    );
+  $('#search-results-window .panel-body').append(results_iframe);
+
+  searchBox.DOMPopupSearchResultsWindow = function() {
+    return document.getElementById("search-results-window");
+  }
+
+  function update_search_results_window() {
+    $('#search-results-window').removeClass('panel-default panel-success panel-warning panel-danger')
+    var status = $('#MSearchResults').contents().find('.SRStatus:visible');
+    if (status.length > 0) {
+      switch(status.attr('id')) {
+        case 'Loading':
+        case 'Searching':
+          $('#search-results-window').addClass('panel-warning');
+          break;
+        case 'NoMatches':
+          $('#search-results-window').addClass('panel-danger');
+          break;
+        default:
+          $('#search-results-window').addClass('panel-default');
+      }
+    } else {
+      $('#search-results-window').addClass('panel-success');
+    }
+  }
+  $('#MSearchResults').load(function() {
+    $('#MSearchResults').contents().find('link[href="search.css"]').attr('href','../doxygen.css');
+    $('#MSearchResults').contents().find('head').append(
+      '<link href="../customdoxygen.css" rel="stylesheet" type="text/css">');
+
+    update_search_results_window();
+
+    // detect status changes (only for search with external search backend)
+    var observer = new MutationObserver(function(mutations) {
+      update_search_results_window();
+    });
+    var config = { attributes: true};
+
+    var targets = $('#MSearchResults').contents().find('.SRStatus');
+    for (i = 0; i < targets.length; i++) {
+      observer.observe(targets[i], config);
+    }
+  });
+
+
+  /* enumerations */
+  $('table.fieldtable').removeClass('fieldtable').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');
+  });
+
+  /* todo list */
+  var todoelements = $('.contents > .textblock > dl.reflist > dt, .contents > .textblock > dl.reflist > dd');
+  for (var i = 0; i < todoelements.length; i += 2) {
+    $('.contents > .textblock').append(
+      '<div class="panel panel-default active">'
+        + "<div class=\"panel-heading todoname\">" + $(todoelements[i]).html() + "</div>"
+        + "<div class=\"panel-body\">" + $(todoelements[i+1]).html() + "</div>"
+      + '</div>');
+  }
+  $('.contents > .textblock > dl').remove();
+
+
+	$(".memitem").removeClass('memitem');
    $(".memproto").removeClass('memproto');
    $(".memdoc").removeClass('memdoc');
-    $("span.mlabel").removeClass('mlabel');
-    $("table.memberdecls").removeClass('memberdecls');
+	$("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");
+	$(".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();
-	}
-    });
+	$('.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();
+    }
+  });
+	$('td.memTemplItemLeft').each(function(){
+		if($(this).siblings('.memTemplItemRight').html()=="") {
+			$(this).attr('colspan', 2);
+			$(this).siblings('.memTemplItemRight').remove();
+		}
+	});
+  searchBox.CloseResultsWindow();
 });
--- a/doxygen/doxygen.config
+++ b/doxygen/doxygen.config
--- a/doxygen/footer.html
+++ b/doxygen/footer.html
@ -1,6 +1,5 @@
 <!-- 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>
@ -12,6 +11,10 @@
 </div>
 <!--END GENERATE_TREEVIEW-->
 </div>
+</div>
+</div>
+</div>
+</div>
 <!--BEGIN !GENERATE_TREEVIEW-->
 <hr class="footer"/><address class="footer"><small>
 $generatedby &#160;<a href="http://www.doxygen.org/index.html">
--- a/doxygen/header.html
+++ b/doxygen/header.html
@ -10,7 +10,6 @@
        <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-->
@ -18,29 +17,26 @@
        <script type="text/javascript" src="$relpath^dynsections.js"></script>
        $treeview
        $search
-
+        $mathjax
        <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
-
-        <link rel="stylesheet" href="http://bootswatch.com/journal/bootstrap.min.css">
+        $extrastylesheet
+        <link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
+        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/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>
+    <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>
+                    <a class="navbar-brand">$projectname $projectnumber</a>
                </div>
            </div>
        </nav>
-
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div class="content" id="content">
-
+                <div class="container">
+                    <div class="row">
+                        <div class="col-sm-12 panel " style="padding-bottom: 15px;">
+                            <div style="margin-bottom: 15px;">
 <!-- end header part -->
--- a/doxygen/style.css
+++ b/doxygen/style.css
@ -100,21 +100,23 @@ 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;
+#navrow1, #navrow2, #navrow3, #navrow4, #navrow5{
+    border-bottom: 1px solid #EEEEEE;
 }

 .adjust-right {
-    margin-left: 30px !important;
-    font-size: 1.15em !important;
+margin-left: 30px !important;
+font-size: 1.15em !important;
 }
 .navbar{
-    border: 0px solid #222 !important;
+ border: 0px solid #222 !important;
 }
+table{
+    white-space:pre-wrap !important;
+}
+/*
+ ===========================
+ */


 /* Sticky footer styles
@ -231,35 +233,32 @@ pre.fragment {
    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 {
-    margin: 8px 8px 8px 8px;
-    border: 0px solid #C4CFE5;
-    background-color: #F6F7F8;
-    box-shadow: none;
-    padding: 15px;
-    padding-bottom: 10px;
+    padding: 4px 6px;
+    margin: 4px 8px 4px 2px;
+    border: 1px solid #C4CFE5;
 }

 div.line {
-    font-family: monospace, fixed;
-    font-size: 15px;
-    min-height: 20px;
+    font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    font-size: 12px;
+    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+ */
+    word-wrap: normal;      /* 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;
@ -272,6 +271,9 @@ div.line {
    transition-property: background-color, box-shadow;
    transition-duration: 0.5s;
 }
+div.line:hover{
+    background-color: #FBFF00;
+}

 div.line.glow {
    background-color: cyan;
@ -280,18 +282,23 @@ div.line.glow {


 span.lineno {
-    padding-right: 5px;
+    padding-right: 4px;
    text-align: right;
-    border-right: 2px solid #adc;
-    background-color: transparent;
+    color:rgba(0,0,0,0.3);
+    border-right: 1px solid #EEE;
+    border-left: 1px solid #EEE;
+    background-color: #FFF;
    white-space: pre;
+    font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace ;
 }
 span.lineno a {
-    background-color: #eee;
+    background-color: #FAFAFA;
+    cursor:pointer;
 }

 span.lineno a:hover {
-    background-color: #C8C8C8;
+    background-color: #EFE200;
+    color: #1e1e1e;
 }

 div.groupHeader {
@ -358,10 +365,104 @@ blockquote {
    padding: 0 12px 0 16px;
 }

-div.summary {
-    float: right;
-    font-size: 8pt;
-    padding-right: 5px;
-    width: 80%;
-    text-align: right;
+/*---------------- Search Box */
+
+#search-box {
+  margin: 10px 0px;
+}
+#search-box .close {
+  display: none;
+  position: absolute;
+  right: 0px;
+  padding: 6px 12px;
+  z-index: 5;
+}
+
+/*---------------- Search results window */
+
+#search-results-window {
+  display: none;
+}
+
+iframe#MSearchResults {
+  width: 100%;
+  height: 15em;
+}
+
+.SRChildren {
+  padding-left: 3ex; padding-bottom: .5em
+}
+.SRPage .SRChildren {
+  display: none;
+}
+a.SRScope {
+  display: block;
+}
+a.SRSymbol:focus, a.SRSymbol:active,
+a.SRScope:focus, a.SRScope:active {
+  text-decoration: underline;
+}
+span.SRScope {
+  padding-left: 4px;
+}
+.SRResult {
+  display: none;
+}
+
+/* class and file list */
+.directory .icona,
+.directory .arrow {
+  height: auto;
+}
+.directory .icona .icon {
+  height: 16px;
+}
+.directory .icondoc {
+  background-position: 0px 0px;
+  height: 20px;
+}
+.directory .iconfopen {
+  background-position: 0px 0px;
+}
+.directory td.entry {
+  padding: 7px 8px 6px 8px;
+}
+
+.table > tbody > tr > td.memSeparator {
+  line-height: 0;
+  .table-hover;
+
+}
+
+.memItemLeft, .memTemplItemLeft {
+  white-space: normal;
+}
+
+/* enumerations */
+.panel-body thead > tr {
+  background-color: #e0e0e0;
+}
+
+/* todo lists */
+.todoname,
+.todoname a {
+  font-weight: bold;
+}
+
+/* Class title */
+.summary {
+  margin-top: 25px;
+}
+.page-header {
+  margin: 20px 0px !important;
+}
+.page-header .title {
+  display: inline-block;
+}
+.page-header .pull-right {
+  margin-top: 0.3em;
+  margin-left: 0.5em;
+}
+.page-header .label {
+  font-size: 50%;
 }