atria-tools/doxy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[DEV] better display

Browse Source
This commit is contained in:
Edouard DUPIN 2016-03-31 22:17:30 +02:00
parent d4a54bbf5b
commit a659faff81
3 changed files with 192 additions and 187 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doxy/default_doxy_file.dox
View File

@ -44,7 +44,7 @@ PROJECT_NUMBER = 1.0.0
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short. # quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = Stuff PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55 # in the documentation. The maximum height of the logo should not exceed 55
@ -98,7 +98,7 @@ OUTPUT_LANGUAGE = English
# documentation (similar to Javadoc). Set to NO to disable this. # documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES. # The default value is: YES.
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = NO
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description # description of a member or function before the detailed description
@ -319,7 +319,7 @@ AUTOLINK_SUPPORT = YES
# diagrams that involve STL classes more complete and accurate. # diagrams that involve STL classes more complete and accurate.
# The default value is: NO. # The default value is: NO.
BUILTIN_STL_SUPPORT = NO BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to # If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support. # enable parsing support.
@ -740,7 +740,7 @@ WARN_IF_DOC_ERROR = YES
# parameter documentation, but not about the absence of documentation. # parameter documentation, but not about the absence of documentation.
# The default value is: NO. # The default value is: NO.
WARN_NO_PARAMDOC = NO WARN_NO_PARAMDOC = YES
# The WARN_FORMAT tag determines the format of the warning messages that doxygen # The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which # can produce. The string should contain the $file, $line, and $text tags, which
@ -823,7 +823,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to # Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/* # exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = EXCLUDE_PATTERNS = debug.h
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the # (namespaces, classes, functions, etc.) that should be excluded from the

1
doxy/doxygen-bootstrapped/customdoxygen.css
View File

@ -318,6 +318,7 @@ span.SRScope {
.table > tbody > tr > td.memSeparator { .table > tbody > tr > td.memSeparator {
line-height: 0; line-height: 0;
padding: 0;
} }
.memItemLeft, .memTemplItemLeft { .memItemLeft, .memTemplItemLeft {
white-space: normal; white-space: normal;

364
doxy/doxygen-bootstrapped/doxy-boot.js
View File

@ -1,60 +1,60 @@
$( document ).ready(function() { $( document ).ready(function() {
$("div.headertitle").addClass("page-header"); $("div.headertitle").addClass("page-header");
$("div.title").addClass("h1"); $("div.title").addClass("h1");
$('li > a[href="index.html"] > span').before("<i class='fa fa-cog'></i> "); $('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="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="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="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="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="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.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_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_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_enum.html"] > span').before("<i class='fa fa-list'></i> ");
$('li > a[href="functions_eval.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="ftv2ns.png"]').replaceWith('<span class="label label-danger">N</span> ');
$('img[src="ftv2cl.png"]').replaceWith('<span class="label label-danger">C</span> '); $('img[src="ftv2cl.png"]').replaceWith('<span class="label label-danger">C</span> ');
$("ul.tablist").addClass("nav nav-pills nav-justified"); $("ul.tablist").addClass("nav nav-pills nav-justified");
$("ul.tablist").css("margin-top", "0.5em"); $("ul.tablist").css("margin-top", "0.5em");
$("ul.tablist").css("margin-bottom", "0.5em"); $("ul.tablist").css("margin-bottom", "0.5em");
$("li.current").addClass("active"); $("li.current").addClass("active");
$("iframe").attr("scrolling", "yes"); $("iframe").attr("scrolling", "yes");
$("#nav-path > ul").addClass("breadcrumb"); $("#nav-path > ul").addClass("breadcrumb");
$("table.params").addClass("table"); $("table.params").addClass("table");
$("div.ingroups").wrapInner("<small></small>"); $("div.ingroups").wrapInner("<small></small>");
$("div.levels").css("margin", "0.5em"); $("div.levels").css("margin", "0.5em");
$("div.levels > span").addClass("btn btn-default btn-xs"); $("div.levels > span").addClass("btn btn-default btn-xs");
$("div.levels > span").css("margin-right", "0.25em"); $("div.levels > span").css("margin-right", "0.25em");
$("table.directory").addClass("table table-striped"); $("table.directory").addClass("table table-striped");
$("div.summary > a").addClass("btn btn-default btn-xs"); $("div.summary > a").addClass("btn btn-default btn-xs");
$("table.fieldtable").addClass("table"); $("table.fieldtable").addClass("table");
$(".fragment").addClass("well"); $(".fragment").addClass("well");
$(".memitem").addClass("panel panel-default"); $(".memitem").addClass("panel panel-default");
$(".memproto").addClass("panel-heading"); $(".memproto").addClass("panel-heading");
$(".memdoc").addClass("panel-body"); $(".memdoc").addClass("panel-body");
$("span.mlabel").addClass("label label-info"); $("span.mlabel").addClass("label label-info");
$("table.memberdecls").addClass("table"); $("table.memberdecls").addClass("table");
$("[class^=memitem]").addClass("active"); $("[class^=memitem]").addClass("active");
$("div.ah").addClass("btn btn-default"); $("div.ah").addClass("btn btn-default");
$("span.mlabels").addClass("pull-right"); $("span.mlabels").addClass("pull-right");
$("table.mlabels").css("width", "100%") $("table.mlabels").css("width", "100%")
$("td.mlabels-right").addClass("pull-right"); $("td.mlabels-right").addClass("pull-right");
$("div.ttc").addClass("panel panel-primary"); $("div.ttc").addClass("panel panel-primary");
$("div.ttname").addClass("panel-heading"); $("div.ttname").addClass("panel-heading");
$("div.ttname a").css("color", 'white'); $("div.ttname a").css("color", 'white');
$("div.ttdef,div.ttdoc,div.ttdeci").addClass("panel-body"); $("div.ttdef,div.ttdoc,div.ttdeci").addClass("panel-body");
$('div.fragment.well div.line:first').css('margin-top', '15px'); $('div.fragment.well div.line:first').css('margin-top', '15px');
$('div.fragment.well div.line:last').css('margin-bottom', '15px'); $('div.fragment.well div.line:last').css('margin-bottom', '15px');
$('table.doxtable').removeClass('doxtable').addClass('table table-striped table-bordered').each(function(){ $('table.doxtable').removeClass('doxtable').addClass('table table-striped table-bordered').each(function(){
$(this).prepend('<thead></thead>'); $(this).prepend('<thead></thead>');
@ -67,15 +67,17 @@ $( document ).ready(function() {
if($('div.fragment.well div.ttc').length > 0) if($('div.fragment.well div.ttc').length > 0)
{ {
$('div.fragment.well div.line:first').parent().removeClass('fragment well'); $('div.fragment.well div.line:first').parent().removeClass('fragment well');
} }
//merge left ad right element in the fuction table item
$('table.memberdecls').find('.memItemRight').each(function(){ /*
$(this).contents().appendTo($(this).siblings('.memItemLeft')); $('table.memberdecls').find('.memItemRight').each(function(){
$(this).siblings('.memItemLeft').attr('align', 'left'); $(this).contents().appendTo($(this).siblings('.memItemLeft'));
}); $(this).siblings('.memItemLeft').attr('align', 'left');
});
*/
function getOriginalWidthOfImg(img_element) { function getOriginalWidthOfImg(img_element) {
var t = new Image(); var t = new Image();
@ -89,156 +91,158 @@ $( document ).ready(function() {
}); });
/* responsive search box */ /* responsive search box */
$('#MSearchBox').parent().remove(); $('#MSearchBox').parent().remove();
var nav_container = $('<div class="row"></div>'); var nav_container = $('<div class="row"></div>');
$('#navrow1').parent().prepend(nav_container); $('#navrow1').parent().prepend(nav_container);
var left_nav = $('<div class="col-md-9"></div>'); var left_nav = $('<div class="col-md-9"></div>');
for (i = 0; i < 6; i++) { for (i = 0; i < 6; i++) {
var navrow = $('#navrow' + i + ' > ul.tablist').detach(); var navrow = $('#navrow' + i + ' > ul.tablist').detach();
left_nav.append(navrow); left_nav.append(navrow);
$('#navrow' + i).remove(); $('#navrow' + i).remove();
} }
var right_nav = $('<div class="col-md-3"></div>').append('\ var right_nav = $('<div class="col-md-3"></div>').append('\
<div id="search-box" class="input-group">\ <div id="search-box" class="input-group">\
<div class="input-group-btn">\ <div class="input-group-btn">\
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">\ <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>\ <span class="glyphicon glyphicon-search"></span> <span class="caret"></span>\
</button>\ </button>\
<ul class="dropdown-menu">\ <ul class="dropdown-menu">\
</ul>\ </ul>\
</div>\ </div>\
<button id="search-close" type="button" class="close" aria-label="Close"><span aria-hidden="true">&times;</span></button>\ <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">\ <input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">\
</div>'); </div>');
$(nav_container).append(left_nav); $(nav_container).append(left_nav);
$(nav_container).append(right_nav); $(nav_container).append(right_nav);
$('#MSearchSelectWindow .SelectionMark').remove(); $('#MSearchSelectWindow .SelectionMark').remove();
var search_selectors = $('#MSearchSelectWindow .SelectItem'); var search_selectors = $('#MSearchSelectWindow .SelectItem');
for (var i = 0; i < search_selectors.length; i += 1) { for (var i = 0; i < search_selectors.length; i += 1) {
var element_a = $('<a href="#"></a>').text($(search_selectors[i]).text()); var element_a = $('<a href="#"></a>').text($(search_selectors[i]).text());
element_a.click(function(){ element_a.click(function(){
$('#search-box .dropdown-menu li').removeClass('active'); $('#search-box .dropdown-menu li').removeClass('active');
$(this).parent().addClass('active'); $(this).parent().addClass('active');
searchBox.OnSelectItem($('#search-box li a').index(this)); searchBox.OnSelectItem($('#search-box li a').index(this));
searchBox.Search(); searchBox.Search();
return false; return false;
}); });
var element = $('<li></li>').append(element_a); var element = $('<li></li>').append(element_a);
$('#search-box .dropdown-menu').append(element); $('#search-box .dropdown-menu').append(element);
} }
$('#MSearchSelectWindow').remove(); $('#MSearchSelectWindow').remove();
$('#search-box .close').click(function (){ $('#search-box .close').click(function (){
searchBox.CloseResultsWindow(); searchBox.CloseResultsWindow();
}); });
$('body').append('<div id="MSearchClose"></div>'); $('body').append('<div id="MSearchClose"></div>');
$('body').append('<div id="MSearchBox"></div>'); $('body').append('<div id="MSearchBox"></div>');
$('body').append('<div id="MSearchSelectWindow"></div>'); $('body').append('<div id="MSearchSelectWindow"></div>');
searchBox.searchLabel = ''; searchBox.searchLabel = '';
searchBox.DOMSearchField = function() { searchBox.DOMSearchField = function() {
return document.getElementById("search-field"); return document.getElementById("search-field");
} }
searchBox.DOMSearchClose = function(){ searchBox.DOMSearchClose = function(){
return document.getElementById("search-close"); return document.getElementById("search-close");
} }
/* search results */ /* search results */
var results_iframe = $('#MSearchResults').detach(); var results_iframe = $('#MSearchResults').detach();
$('#MSearchResultsWindow') $('#MSearchResultsWindow')
.attr('id', 'search-results-window') .attr('id', 'search-results-window')
.addClass('panel panel-default') .addClass('panel panel-default')
.append( .append(
'<div class="panel-heading">\ '<div class="panel-heading">\
<h3 class="panel-title">Search Results</h3>\ <h3 class="panel-title">Search Results</h3>\
</div>\ </div>\
<div class="panel-body"></div>' <div class="panel-body"></div>'
); );
$('#search-results-window .panel-body').append(results_iframe); $('#search-results-window .panel-body').append(results_iframe);
searchBox.DOMPopupSearchResultsWindow = function() { searchBox.DOMPopupSearchResultsWindow = function() {
return document.getElementById("search-results-window"); return document.getElementById("search-results-window");
} }
function update_search_results_window() { function update_search_results_window() {
$('#search-results-window').removeClass('panel-default panel-success panel-warning panel-danger') $('#search-results-window').removeClass('panel-default panel-success panel-warning panel-danger')
var status = $('#MSearchResults').contents().find('.SRStatus:visible'); var status = $('#MSearchResults').contents().find('.SRStatus:visible');
if (status.length > 0) { if (status.length > 0) {
switch(status.attr('id')) { switch(status.attr('id')) {
case 'Loading': case 'Loading':
case 'Searching': case 'Searching':
$('#search-results-window').addClass('panel-warning'); $('#search-results-window').addClass('panel-warning');
break; break;
case 'NoMatches': case 'NoMatches':
$('#search-results-window').addClass('panel-danger'); $('#search-results-window').addClass('panel-danger');
break; break;
default: default:
$('#search-results-window').addClass('panel-default'); $('#search-results-window').addClass('panel-default');
} }
} else { } else {
$('#search-results-window').addClass('panel-success'); $('#search-results-window').addClass('panel-success');
} }
} }
$('#MSearchResults').load(function() { $('#MSearchResults').load(function() {
$('#MSearchResults').contents().find('link[href="search.css"]').attr('href','../doxygen.css'); $('#MSearchResults').contents().find('link[href="search.css"]').attr('href','../doxygen.css');
$('#MSearchResults').contents().find('head').append( $('#MSearchResults').contents().find('head').append(
'<link href="../customdoxygen.css" rel="stylesheet" type="text/css">'); '<link href="../customdoxygen.css" rel="stylesheet" type="text/css">');
update_search_results_window(); update_search_results_window();
// detect status changes (only for search with external search backend) // detect status changes (only for search with external search backend)
var observer = new MutationObserver(function(mutations) { var observer = new MutationObserver(function(mutations) {
update_search_results_window(); update_search_results_window();
}); });
var config = { attributes: true}; var config = {
attributes: true
};
var targets = $('#MSearchResults').contents().find('.SRStatus'); var targets = $('#MSearchResults').contents().find('.SRStatus');
for (i = 0; i < targets.length; i++) { for (i = 0; i < targets.length; i++) {
observer.observe(targets[i], config); observer.observe(targets[i], config);
} }
}); });
/* enumerations */ /* enumerations */
$('table.fieldtable').removeClass('fieldtable').addClass('table table-striped table-bordered').each(function(){ $('table.fieldtable').removeClass('fieldtable').addClass('table table-striped table-bordered').each(function(){
$(this).prepend('<thead></thead>'); $(this).prepend('<thead></thead>');
$(this).find('tbody > tr:first').prependTo($(this).find('thead')); $(this).find('tbody > tr:first').prependTo($(this).find('thead'));
$(this).find('td > span.success').parent().addClass('success'); $(this).find('td > span.success').parent().addClass('success');
$(this).find('td > span.warning').parent().addClass('warning'); $(this).find('td > span.warning').parent().addClass('warning');
$(this).find('td > span.danger').parent().addClass('danger'); $(this).find('td > span.danger').parent().addClass('danger');
}); });
/* todo list */ /* todo list */
var todoelements = $('.contents > .textblock > dl.reflist > dt, .contents > .textblock > dl.reflist > dd'); var todoelements = $('.contents > .textblock > dl.reflist > dt, .contents > .textblock > dl.reflist > dd');
for (var i = 0; i < todoelements.length; i += 2) { for (var i = 0; i < todoelements.length; i += 2) {
$('.contents > .textblock').append( $('.contents > .textblock').append(
'<div class="panel panel-default active">' '<div class="panel panel-default active">'
+ "<div class=\"panel-heading todoname\">" + $(todoelements[i]).html() + "</div>" + "<div class=\"panel-heading todoname\">" + $(todoelements[i]).html() + "</div>"
+ "<div class=\"panel-body\">" + $(todoelements[i+1]).html() + "</div>" + "<div class=\"panel-body\">" + $(todoelements[i+1]).html() + "</div>"
+ '</div>'); + '</div>');
} }
$('.contents > .textblock > dl').remove(); $('.contents > .textblock > dl').remove();
$(".memitem").removeClass('memitem'); $(".memitem").removeClass('memitem');
$(".memproto").removeClass('memproto'); $(".memproto").removeClass('memproto');
$(".memdoc").removeClass('memdoc'); $(".memdoc").removeClass('memdoc');
$("span.mlabel").removeClass('mlabel'); $("span.mlabel").removeClass('mlabel');
$("table.memberdecls").removeClass('memberdecls'); $("table.memberdecls").removeClass('memberdecls');
$("[class^=memitem]").removeClass('memitem'); $("[class^=memitem]").removeClass('memitem');
$("span.mlabels").removeClass('mlabels'); $("span.mlabels").removeClass('mlabels');
$("table.mlabels").removeClass('mlabels'); $("table.mlabels").removeClass('mlabels');
$("td.mlabels-right").removeClass('mlabels-right'); $("td.mlabels-right").removeClass('mlabels-right');
$(".navpath").removeClass('navpath'); $(".navpath").removeClass('navpath');
$("li.navelem").removeClass('navelem'); $("li.navelem").removeClass('navelem');
$("a.el").removeClass('el'); $("a.el").removeClass('el');