Skip to content

Commit adc5693

Browse files
kylonkylon
committed
add doxygen docs site
0 parents  commit adc5693

137 files changed

Lines changed: 15620 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎OpenWinControls.png‎

1.54 KB
Loading

‎annotated.html‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<!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" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.16.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>libOpenWinControls: Class List</title>
9+
<link rel="icon" href="OpenWinControls.png" type="image/x-icon" />
10+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
11+
<script type="text/javascript" src="jquery.js"></script>
12+
<script type="text/javascript" src="dynsections.js"></script>
13+
<script type="text/javascript" src="clipboard.js"></script>
14+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
15+
<script type="text/javascript" src="navtreedata.js"></script>
16+
<script type="text/javascript" src="navtree.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
18+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
19+
<script type="text/javascript" src="search/searchdata.js"></script>
20+
<script type="text/javascript" src="search/search.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
</head>
23+
<body>
24+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25+
<div id="titlearea">
26+
<table cellspacing="0" cellpadding="0">
27+
<tbody>
28+
<tr id="projectrow">
29+
<td id="projectalign">
30+
<div id="projectname">libOpenWinControls
31+
</div>
32+
<div id="projectbrief">Multiplatform open-source library to interact with the dual-mode controller in GPD devices</div>
33+
</td>
34+
</tr>
35+
</tbody>
36+
</table>
37+
</div>
38+
<!-- end header part -->
39+
<!-- Generated by Doxygen 1.16.1 -->
40+
<script type="text/javascript">
41+
var searchBox = new SearchBox("searchBox", "search/",'.html');
42+
</script>
43+
<script type="text/javascript">
44+
$(function() { codefold.init(); });
45+
</script>
46+
<script type="text/javascript" src="menudata.js"></script>
47+
<script type="text/javascript" src="menu.js"></script>
48+
<script type="text/javascript">
49+
$(function() {
50+
initMenu('',true,false,'search.php','Search',true);
51+
$(function() { init_search(); });
52+
});
53+
</script>
54+
<div id="main-nav"></div>
55+
</div><!-- top -->
56+
<div id="side-nav" class="ui-resizable side-nav-resizable">
57+
<div id="nav-tree">
58+
<div id="nav-tree-contents">
59+
<div id="nav-sync" class="sync"></div>
60+
</div>
61+
</div>
62+
<div id="splitbar" style="-moz-user-select:none;"
63+
class="ui-resizable-handle">
64+
</div>
65+
</div>
66+
<script type="text/javascript">
67+
$(function(){initNavTree('annotated.html','',''); });
68+
</script>
69+
<div id="container">
70+
<div id="doc-content">
71+
<!-- window showing the filter options -->
72+
<div id="MSearchSelectWindow"
73+
onmouseover="return searchBox.OnSearchSelectShow()"
74+
onmouseout="return searchBox.OnSearchSelectHide()"
75+
onkeydown="return searchBox.OnSearchSelectKey(event)">
76+
</div>
77+
78+
<!-- iframe showing the search results (closed by default) -->
79+
<div id="MSearchResultsWindow">
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>
90+
</div>
91+
92+
<div class="header">
93+
<div class="headertitle"><div class="title">Class List</div></div>
94+
</div><!--header-->
95+
<div class="contents">
96+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
97+
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span>]</div><table class="directory">
98+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">N</span></span><b>OWC</b></td><td class="desc"></td></tr>
99+
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d3/d07/classOWC_1_1Controller.html" target="_self">Controller</a></td><td class="desc"><a class="el" href="d3/d07/classOWC_1_1Controller.html" title="Controller abstract base class.">Controller</a> abstract base class </td></tr>
100+
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d7/d00/classOWC_1_1ControllerV1.html" target="_self">ControllerV1</a></td><td class="desc">Interact with controller V1 devices </td></tr>
101+
<tr id="row_0_2_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="d4/d00/classOWC_1_1ControllerV2.html" target="_self">ControllerV2</a></td><td class="desc">Interact with controller V2 devices </td></tr>
102+
</table>
103+
</div><!-- directory -->
104+
</div><!-- contents -->
105+
</div><!-- doc-content -->
106+
</div><!-- container -->
107+
<!-- start footer part -->
108+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
109+
<ul>
110+
<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.16.1 </li>
111+
</ul>
112+
</div>
113+
</body>
114+
</html>

‎annotated_dup.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
var annotated_dup =
2+
[
3+
[ "OWC", null, [
4+
[ "Controller", "d3/d07/classOWC_1_1Controller.html", "d3/d07/classOWC_1_1Controller" ],
5+
[ "ControllerV1", "d7/d00/classOWC_1_1ControllerV1.html", "d7/d00/classOWC_1_1ControllerV1" ],
6+
[ "ControllerV2", "d4/d00/classOWC_1_1ControllerV2.html", "d4/d00/classOWC_1_1ControllerV2" ]
7+
] ]
8+
];

‎classes.html‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!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" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.16.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>libOpenWinControls: Class Index</title>
9+
<link rel="icon" href="OpenWinControls.png" type="image/x-icon" />
10+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
11+
<script type="text/javascript" src="jquery.js"></script>
12+
<script type="text/javascript" src="dynsections.js"></script>
13+
<script type="text/javascript" src="clipboard.js"></script>
14+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
15+
<script type="text/javascript" src="navtreedata.js"></script>
16+
<script type="text/javascript" src="navtree.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
18+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
19+
<script type="text/javascript" src="search/searchdata.js"></script>
20+
<script type="text/javascript" src="search/search.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
</head>
23+
<body>
24+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25+
<div id="titlearea">
26+
<table cellspacing="0" cellpadding="0">
27+
<tbody>
28+
<tr id="projectrow">
29+
<td id="projectalign">
30+
<div id="projectname">libOpenWinControls
31+
</div>
32+
<div id="projectbrief">Multiplatform open-source library to interact with the dual-mode controller in GPD devices</div>
33+
</td>
34+
</tr>
35+
</tbody>
36+
</table>
37+
</div>
38+
<!-- end header part -->
39+
<!-- Generated by Doxygen 1.16.1 -->
40+
<script type="text/javascript">
41+
var searchBox = new SearchBox("searchBox", "search/",'.html');
42+
</script>
43+
<script type="text/javascript">
44+
$(function() { codefold.init(); });
45+
</script>
46+
<script type="text/javascript" src="menudata.js"></script>
47+
<script type="text/javascript" src="menu.js"></script>
48+
<script type="text/javascript">
49+
$(function() {
50+
initMenu('',true,false,'search.php','Search',true);
51+
$(function() { init_search(); });
52+
});
53+
</script>
54+
<div id="main-nav"></div>
55+
</div><!-- top -->
56+
<div id="side-nav" class="ui-resizable side-nav-resizable">
57+
<div id="nav-tree">
58+
<div id="nav-tree-contents">
59+
<div id="nav-sync" class="sync"></div>
60+
</div>
61+
</div>
62+
<div id="splitbar" style="-moz-user-select:none;"
63+
class="ui-resizable-handle">
64+
</div>
65+
</div>
66+
<script type="text/javascript">
67+
$(function(){initNavTree('classes.html','',''); });
68+
</script>
69+
<div id="container">
70+
<div id="doc-content">
71+
<!-- window showing the filter options -->
72+
<div id="MSearchSelectWindow"
73+
onmouseover="return searchBox.OnSearchSelectShow()"
74+
onmouseout="return searchBox.OnSearchSelectHide()"
75+
onkeydown="return searchBox.OnSearchSelectKey(event)">
76+
</div>
77+
78+
<!-- iframe showing the search results (closed by default) -->
79+
<div id="MSearchResultsWindow">
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>
90+
</div>
91+
92+
<div class="header">
93+
<div class="headertitle"><div class="title">Class Index</div></div>
94+
</div><!--header-->
95+
<div class="contents">
96+
<div class="qindex"><a class="qindex" href="#letter_C">C</a></div>
97+
<div class="classindex">
98+
<dl class="classindex even">
99+
<dt class="alphachar"><a id="letter_C" name="letter_C">C</a></dt>
100+
<dd><a class="el" href="d3/d07/classOWC_1_1Controller.html">Controller</a> (OWC)</dd><dd><a class="el" href="d7/d00/classOWC_1_1ControllerV1.html">ControllerV1</a> (OWC)</dd><dd><a class="el" href="d4/d00/classOWC_1_1ControllerV2.html">ControllerV2</a> (OWC)</dd></dl>
101+
</div>
102+
</div><!-- contents -->
103+
</div><!-- doc-content -->
104+
</div><!-- container -->
105+
<!-- start footer part -->
106+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
107+
<ul>
108+
<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.16.1 </li>
109+
</ul>
110+
</div>
111+
</body>
112+
</html>

‎clipboard.js‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/**
2+
3+
The code below is based on the Doxygen Awesome project, see
4+
https://github.com/jothepro/doxygen-awesome-css
5+
6+
MIT License
7+
8+
Copyright (c) 2021 - 2022 jothepro
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
28+
*/
29+
30+
let clipboard_title = "Copy to clipboard"
31+
let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path fill="#888" d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
32+
let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
33+
let clipboard_successDuration = 1000
34+
35+
$(function() {
36+
if(navigator.clipboard) {
37+
const fragments = document.getElementsByClassName("fragment")
38+
for(const fragment of fragments) {
39+
const clipboard_div = document.createElement("div")
40+
clipboard_div.classList.add("clipboard")
41+
clipboard_div.innerHTML = clipboard_icon
42+
clipboard_div.title = clipboard_title
43+
$(clipboard_div).click(function() {
44+
const content = this.parentNode.cloneNode(true)
45+
// filter out line number and folded fragments from file listings
46+
content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
47+
let text = content.textContent
48+
// remove trailing newlines and trailing spaces from empty lines
49+
text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
50+
navigator.clipboard.writeText(text);
51+
this.classList.add("success")
52+
this.innerHTML = clipboard_successIcon
53+
window.setTimeout(() => { // switch back to normal icon after timeout
54+
this.classList.remove("success")
55+
this.innerHTML = clipboard_icon
56+
}, clipboard_successDuration);
57+
})
58+
fragment.insertBefore(clipboard_div, fragment.firstChild)
59+
}
60+
}
61+
})

‎cookie.js‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*!
2+
Cookie helper functions
3+
Copyright (c) 2023 Dimitri van Heesch
4+
Released under MIT license.
5+
*/
6+
let Cookie = {
7+
cookie_namespace: 'doxygen_',
8+
9+
readSetting(cookie,defVal) {
10+
if (window.chrome) {
11+
const val = localStorage.getItem(this.cookie_namespace+cookie) ||
12+
sessionStorage.getItem(this.cookie_namespace+cookie);
13+
if (val) return val;
14+
} else {
15+
let myCookie = this.cookie_namespace+cookie+"=";
16+
if (document.cookie) {
17+
const index = document.cookie.indexOf(myCookie);
18+
if (index != -1) {
19+
const valStart = index + myCookie.length;
20+
let valEnd = document.cookie.indexOf(";", valStart);
21+
if (valEnd == -1) {
22+
valEnd = document.cookie.length;
23+
}
24+
return document.cookie.substring(valStart, valEnd);
25+
}
26+
}
27+
}
28+
return defVal;
29+
},
30+
31+
writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
32+
if (window.chrome) {
33+
if (days==0) {
34+
sessionStorage.setItem(this.cookie_namespace+cookie,val);
35+
} else {
36+
localStorage.setItem(this.cookie_namespace+cookie,val);
37+
}
38+
} else {
39+
let date = new Date();
40+
date.setTime(date.getTime()+(days*24*60*60*1000));
41+
const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
42+
document.cookie = this.cookie_namespace + cookie + "=" +
43+
val + "; SameSite=Lax;" + expiration + "path=/";
44+
}
45+
},
46+
47+
eraseSetting(cookie) {
48+
if (window.chrome) {
49+
if (localStorage.getItem(this.cookie_namespace+cookie)) {
50+
localStorage.removeItem(this.cookie_namespace+cookie);
51+
} else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
52+
sessionStorage.removeItem(this.cookie_namespace+cookie);
53+
}
54+
} else {
55+
this.writeSetting(cookie,'',-1);
56+
}
57+
},
58+
}

0 commit comments

Comments
 (0)