Skip to content

Commit ce03b96

Browse files
pu2clrpu2clr
committed
Documentation
1 parent a95930f commit ce03b96

22 files changed

+950
-577
lines changed

‎extras/apidoc/html/bc_sd.png

529 Bytes
Loading

‎extras/apidoc/html/docd.png

803 Bytes
Loading

‎extras/apidoc/html/doxygen.css

Lines changed: 575 additions & 409 deletions
Large diffs are not rendered by default.

‎extras/apidoc/html/dynsections.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ function updateStripes()
4747
{
4848
$('table.directory tr').
4949
removeClass('even').filter(':visible:even').addClass('even');
50+
$('table.directory tr').
51+
removeClass('odd').filter(':visible:odd').addClass('odd');
5052
}
5153

5254
function toggleLevel(level)

‎extras/apidoc/html/index.html

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<html xmlns="http://www.w3.org/1999/xhtml">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.9.4"/>
6+
<meta name="generator" content="Doxygen 1.9.6"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>PU2CLR RDA5807 Arduino Library: Main Page</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -34,10 +34,10 @@
3434
</table>
3535
</div>
3636
<!-- end header part -->
37-
<!-- Generated by Doxygen 1.9.4 -->
37+
<!-- Generated by Doxygen 1.9.6 -->
3838
<script type="text/javascript">
3939
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
40-
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
40+
var searchBox = new SearchBox("searchBox", "search/",'.html');
4141
/* @license-end */
4242
</script>
4343
<script type="text/javascript" src="menudata.js"></script>
@@ -77,9 +77,16 @@
7777

7878
<!-- iframe showing the search results (closed by default) -->
7979
<div id="MSearchResultsWindow">
80-
<iframe src="javascript:void(0)" frameborder="0"
81-
name="MSearchResults" id="MSearchResults">
82-
</iframe>
80+
<div id="MSearchResults">
81+
<div class="SRPage">
82+
<div id="SRIndex">
83+
<div id="SRResults"></div>
84+
<div class="SRStatus" id="Loading">Loading...</div>
85+
<div class="SRStatus" id="Searching">Searching...</div>
86+
<div class="SRStatus" id="NoMatches">No Matches</div>
87+
</div>
88+
</div>
89+
</div>
8390
</div>
8491

8592
<div class="header">
@@ -91,7 +98,7 @@
9198
<!-- start footer part -->
9299
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
93100
<ul>
94-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
101+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
95102
</ul>
96103
</div>
97104
</body>

‎extras/apidoc/html/jquery.js

Lines changed: 3 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎extras/apidoc/html/menu.js

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,37 +44,35 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search) {
4444
}
4545
return result;
4646
}
47-
var searchBox;
47+
var searchBoxHtml;
4848
if (searchEnabled) {
4949
if (serverSide) {
50-
searchBox='<div id="MSearchBox" class="MSearchBoxInactive">'+
50+
searchBoxHtml='<div id="MSearchBox" class="MSearchBoxInactive">'+
5151
'<div class="left">'+
5252
'<form id="FSearchBox" action="'+relPath+searchPage+
53-
'" method="get"><img id="MSearchSelect" src="'+
54-
relPath+'search/mag.svg" alt=""/>'+
55-
'<input type="text" id="MSearchField" name="query" value="'+search+
53+
'" method="get"><span id="MSearchSelectExt">&#160;</span>'+
54+
'<input type="text" id="MSearchField" name="query" value="" placeholder="'+search+
5655
'" size="20" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)"'+
57-
' onblur="searchBox.OnSearchFieldFocus(false)">'+
56+
' onblur="searchBox.OnSearchFieldFocus(false)"/>'+
5857
'</form>'+
5958
'</div>'+
6059
'<div class="right"></div>'+
6160
'</div>';
6261
} else {
63-
searchBox='<div id="MSearchBox" class="MSearchBoxInactive">'+
62+
searchBoxHtml='<div id="MSearchBox" class="MSearchBoxInactive">'+
6463
'<span class="left">'+
65-
'<img id="MSearchSelect" src="'+relPath+
66-
'search/mag_sel.svg" onmouseover="return searchBox.OnSearchSelectShow()"'+
67-
' onmouseout="return searchBox.OnSearchSelectHide()" alt=""/>'+
68-
'<input type="text" id="MSearchField" value="'+search+
64+
'<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()"'+
65+
' onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>'+
66+
'<input type="text" id="MSearchField" value="" placeholder="'+search+
6967
'" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" '+
7068
'onblur="searchBox.OnSearchFieldFocus(false)" '+
7169
'onkeyup="searchBox.OnSearchFieldChange(event)"/>'+
7270
'</span>'+
7371
'<span class="right"><a id="MSearchClose" '+
7472
'href="javascript:searchBox.CloseResultsWindow()">'+
7573
'<img id="MSearchCloseImg" border="0" src="'+relPath+
76-
'search/close.svg" alt=""/></a>'
77-
'</span>'
74+
'search/close.svg" alt=""/></a>'+
75+
'</span>'+
7876
'</div>';
7977
}
8078
}
@@ -87,7 +85,7 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search) {
8785
'</div>');
8886
$('#main-nav').append(makeTree(menudata,relPath));
8987
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
90-
if (searchBox) {
88+
if (searchBoxHtml) {
9189
$('#main-menu').append('<li id="searchBoxPos2" style="float:right"></li>');
9290
}
9391
var $mainMenuState = $('#main-menu-state');
@@ -116,14 +114,17 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search) {
116114
if (newWidth!=prevWidth) {
117115
if ($(window).outerWidth()<768) {
118116
$mainMenuState.prop('checked',false); $menu.hide();
119-
$('#searchBoxPos1').html(searchBox);
117+
$('#searchBoxPos1').html(searchBoxHtml);
120118
$('#searchBoxPos2').hide();
121119
} else {
122120
$menu.show();
123121
$('#searchBoxPos1').empty();
124-
$('#searchBoxPos2').html(searchBox);
122+
$('#searchBoxPos2').html(searchBoxHtml);
125123
$('#searchBoxPos2').show();
126124
}
125+
if (typeof searchBox!=='undefined') {
126+
searchBox.CloseResultsWindow();
127+
}
127128
prevWidth = newWidth;
128129
}
129130
}

‎extras/apidoc/html/nav_fd.png

133 Bytes
Loading

‎extras/apidoc/html/nav_hd.png

90 Bytes
Loading

‎extras/apidoc/html/navtree.css

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,13 @@
2222
#nav-tree .selected {
2323
background-image: url('tab_a.png');
2424
background-repeat:repeat-x;
25-
color: #fff;
26-
text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
25+
color: var(--nav-text-active-color);
26+
text-shadow: var(--nav-text-active-shadow);
27+
}
28+
29+
#nav-tree .selected .arrow {
30+
color: var(--nav-arrow-selected-color);
31+
text-shadow: none;
2732
}
2833

2934
#nav-tree img {
@@ -43,7 +48,7 @@
4348
#nav-tree .label {
4449
margin:0px;
4550
padding:0px;
46-
font: 12px 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
51+
font: 12px var(--font-family-nav);
4752
}
4853

4954
#nav-tree .label a {
@@ -52,7 +57,7 @@
5257

5358
#nav-tree .selected a {
5459
text-decoration:none;
55-
color:#fff;
60+
color:var(--nav-text-active-color);
5661
}
5762

5863
#nav-tree .children_ul {
@@ -67,7 +72,6 @@
6772

6873
#nav-tree {
6974
padding: 0px 0px;
70-
background-color: #FAFAFF;
7175
font-size:14px;
7276
overflow:auto;
7377
}
@@ -86,7 +90,7 @@
8690
display:block;
8791
position: absolute;
8892
left: 0px;
89-
width: 250px;
93+
width: $width;
9094
overflow : hidden;
9195
}
9296

@@ -95,7 +99,7 @@
9599
}
96100

97101
.ui-resizable-e {
98-
background-image:url("splitbar.png");
102+
background-image:var(--nav-splitbar-image);
99103
background-size:100%;
100104
background-repeat:repeat-y;
101105
background-attachment: scroll;
@@ -118,9 +122,8 @@
118122
}
119123

120124
#nav-tree {
121-
background-image:url('nav_h.png');
122125
background-repeat:repeat-x;
123-
background-color: #F0FAFB;
126+
background-color: var(--nav-background-color);
124127
-webkit-overflow-scrolling : touch; /* iOS 5+ */
125128
}
126129

‎extras/apidoc/html/resize.js

Lines changed: 43 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -22,52 +22,65 @@
2222
2323
@licend The above is the entire license notice for the JavaScript code in this file
2424
*/
25+
var once=1;
2526
function initResizable()
2627
{
2728
var cookie_namespace = 'doxygen';
28-
var sidenav,navtree,content,header,collapsed,collapsedWidth=0,barWidth=6,desktop_vp=768,titleHeight;
29+
var sidenav,navtree,content,header,barWidth=6,desktop_vp=768,titleHeight;
2930

30-
function readCookie(cookie)
31+
function readSetting(cookie)
3132
{
32-
var myCookie = cookie_namespace+"_"+cookie+"=";
33-
if (document.cookie) {
34-
var index = document.cookie.indexOf(myCookie);
35-
if (index != -1) {
36-
var valStart = index + myCookie.length;
37-
var valEnd = document.cookie.indexOf(";", valStart);
38-
if (valEnd == -1) {
39-
valEnd = document.cookie.length;
33+
if (window.chrome) {
34+
var val = localStorage.getItem(cookie_namespace+'_width');
35+
if (val) return val;
36+
} else {
37+
var myCookie = cookie_namespace+"_"+cookie+"=";
38+
if (document.cookie) {
39+
var index = document.cookie.indexOf(myCookie);
40+
if (index != -1) {
41+
var valStart = index + myCookie.length;
42+
var valEnd = document.cookie.indexOf(";", valStart);
43+
if (valEnd == -1) {
44+
valEnd = document.cookie.length;
45+
}
46+
var val = document.cookie.substring(valStart, valEnd);
47+
return val;
4048
}
41-
var val = document.cookie.substring(valStart, valEnd);
42-
return val;
4349
}
4450
}
45-
return 0;
51+
return 250;
4652
}
4753

48-
function writeCookie(cookie, val, expiration)
54+
function writeSetting(cookie, val)
4955
{
50-
if (val==undefined) return;
51-
if (expiration == null) {
56+
if (window.chrome) {
57+
localStorage.setItem(cookie_namespace+"_width",val);
58+
} else {
5259
var date = new Date();
5360
date.setTime(date.getTime()+(10*365*24*60*60*1000)); // default expiration is one week
5461
expiration = date.toGMTString();
62+
document.cookie = cookie_namespace + "_" + cookie + "=" + val + "; SameSite=Lax; expires=" + expiration+"; path=/";
5563
}
56-
document.cookie = cookie_namespace + "_" + cookie + "=" + val + "; SameSite=Lax; expires=" + expiration+"; path=/";
5764
}
5865

5966
function resizeWidth()
6067
{
6168
var windowWidth = $(window).width() + "px";
6269
var sidenavWidth = $(sidenav).outerWidth();
6370
content.css({marginLeft:parseInt(sidenavWidth)+"px"});
64-
writeCookie('width',sidenavWidth-barWidth, null);
71+
if (typeof page_layout!=='undefined' && page_layout==1) {
72+
footer.css({marginLeft:parseInt(sidenavWidth)+"px"});
73+
}
74+
writeSetting('width',sidenavWidth-barWidth);
6575
}
6676

6777
function restoreWidth(navWidth)
6878
{
6979
var windowWidth = $(window).width() + "px";
7080
content.css({marginLeft:parseInt(navWidth)+barWidth+"px"});
81+
if (typeof page_layout!=='undefined' && page_layout==1) {
82+
footer.css({marginLeft:parseInt(navWidth)+barWidth+"px"});
83+
}
7184
sidenav.css({width:navWidth + "px"});
7285
}
7386

@@ -89,35 +102,24 @@ function initResizable()
89102
content.css({height:contentHeight + "px"});
90103
navtree.css({height:navtreeHeight + "px"});
91104
sidenav.css({height:sideNavHeight + "px"});
92-
var width=$(window).width();
93-
if (width!=collapsedWidth) {
94-
if (width<desktop_vp && collapsedWidth>=desktop_vp) {
95-
if (!collapsed) {
96-
collapseExpand();
97-
}
98-
} else if (width>desktop_vp && collapsedWidth<desktop_vp) {
99-
if (collapsed) {
100-
collapseExpand();
101-
}
102-
}
103-
collapsedWidth=width;
104-
}
105105
if (location.hash.slice(1)) {
106106
(document.getElementById(location.hash.slice(1))||document.body).scrollIntoView();
107107
}
108108
}
109109

110110
function collapseExpand()
111111
{
112+
var newWidth;
112113
if (sidenav.width()>0) {
113-
restoreWidth(0);
114-
collapsed=true;
114+
newWidth=0;
115115
}
116116
else {
117-
var width = readCookie('width');
118-
if (width>200 && width<$(window).width()) { restoreWidth(width); } else { restoreWidth(200); }
119-
collapsed=false;
117+
var width = readSetting('width');
118+
newWidth = (width>250 && width<$(window).width()) ? width : 250;
120119
}
120+
restoreWidth(newWidth);
121+
var sidenavWidth = $(sidenav).outerWidth();
122+
writeSetting('width',sidenavWidth-barWidth);
121123
}
122124

123125
header = $("#top");
@@ -136,15 +138,18 @@ function initResizable()
136138
$('#nav-sync').css({ right:'34px' });
137139
barWidth=20;
138140
}
139-
var width = readCookie('width');
141+
var width = readSetting('width');
140142
if (width) { restoreWidth(width); } else { resizeWidth(); }
141143
resizeHeight();
142144
var url = location.href;
143145
var i=url.indexOf("#");
144146
if (i>=0) window.location.hash=url.substr(i);
145147
var _preventDefault = function(evt) { evt.preventDefault(); };
146148
$("#splitbar").bind("dragstart", _preventDefault).bind("selectstart", _preventDefault);
147-
$(".ui-resizable-handle").dblclick(collapseExpand);
149+
if (once) {
150+
$(".ui-resizable-handle").dblclick(collapseExpand);
151+
once=0
152+
}
148153
$(window).on('load',resizeHeight);
149154
}
150155
/* @license-end */

‎extras/apidoc/html/search/mag.svg

Lines changed: 37 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)