Skip to content

Commit 1613160

Browse files
authored
Merge pull request #2 from libdriver/dev
feat: update doxygen
2 parents 16157dc + 5bcc448 commit 1613160

253 files changed

Lines changed: 13039 additions & 9092 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.

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 1.0.2 (2025-10-26)
2+
3+
## Features
4+
5+
- update doxygen
6+
17
## 1.0.1 (2025-05-16)
28

39
## Bug Fixes

Doxyfile

Lines changed: 788 additions & 432 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
PMSX003 is a kind of digital and universal particle concentration sensor,which can be used to obtain the number of suspended particles in the air,i.e.the concentration of particles,and output them in the form of digital interface. This sensor can be inserted into variable instruments related to the concentration of suspended particles in the air or other environmental improvement equipments to provide correct concentration data in time.
1212

13-
LibDriver PMSX003 is a full-featured driver of PMSX003 launched by LibDriver.It provides the function of air quality reading and other functions. LibDriver is MISRA compliant.
13+
LibDriver PMSX003 is a full-featured driver for PMSX003, launched by LibDriver.It provides air quality reading and additional features. LibDriver is MISRA compliant.
1414

1515
### Table of Contents
1616

doc/html/annotated.html

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,57 @@
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"/>
5-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.15.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>LibDriver PMSX003: Data Structures</title>
9+
<link rel="icon" href="favicon.svg" type="image/x-icon" />
910
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1011
<script type="text/javascript" src="jquery.js"></script>
1112
<script type="text/javascript" src="dynsections.js"></script>
13+
<script type="text/javascript" src="clipboard.js"></script>
1214
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13-
<script type="text/javascript" src="resize.js"></script>
1415
<script type="text/javascript" src="navtreedata.js"></script>
1516
<script type="text/javascript" src="navtree.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
1618
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1719
<script type="text/javascript" src="search/searchdata.js"></script>
1820
<script type="text/javascript" src="search/search.js"></script>
21+
<script type="text/javascript" src="darkmode_toggle.js"></script>
1922
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2023
</head>
2124
<body>
2225
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
2326
<div id="titlearea">
2427
<table cellspacing="0" cellpadding="0">
2528
<tbody>
26-
<tr style="height: 56px;">
29+
<tr id="projectrow">
2730
<td id="projectlogo"><img alt="Logo" src="doxygen.png"/></td>
28-
<td id="projectalign" style="padding-left: 0.5em;">
31+
<td id="projectalign">
2932
<div id="projectname">LibDriver PMSX003
30-
&#160;<span id="projectnumber">1.0.0</span>
3133
</div>
32-
<div id="projectbrief">PMSX003 full-featured driver</div>
3334
</td>
3435
</tr>
3536
</tbody>
3637
</table>
3738
</div>
3839
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.9.1 -->
40+
<!-- Generated by Doxygen 1.15.0 -->
4041
<script type="text/javascript">
41-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
43-
/* @license-end */
42+
var searchBox = new SearchBox("searchBox", "search/",'.html');
43+
</script>
44+
<script type="text/javascript">
45+
$(function() { codefold.init(); });
4446
</script>
4547
<script type="text/javascript" src="menudata.js"></script>
4648
<script type="text/javascript" src="menu.js"></script>
4749
<script type="text/javascript">
48-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4950
$(function() {
50-
initMenu('',true,false,'search.php','Search');
51-
$(document).ready(function() { init_search(); });
51+
initMenu('',true,false,'search.php','Search',true);
52+
$(function() { init_search(); });
5253
});
53-
/* @license-end */</script>
54+
</script>
5455
<div id="main-nav"></div>
5556
</div><!-- top -->
5657
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -64,10 +65,9 @@
6465
</div>
6566
</div>
6667
<script type="text/javascript">
67-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
68-
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
69-
/* @license-end */
68+
$(function(){initNavTree('annotated.html','',''); });
7069
</script>
70+
<div id="container">
7171
<div id="doc-content">
7272
<!-- window showing the filter options -->
7373
<div id="MSearchSelectWindow"
@@ -78,29 +78,36 @@
7878

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

8693
<div class="header">
87-
<div class="headertitle">
88-
<div class="title">Data Structures</div> </div>
94+
<div class="headertitle"><div class="title">Data Structures</div></div>
8995
</div><!--header-->
9096
<div class="contents">
9197
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
9298
<table class="directory">
9399
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpmsx003__data__s.html" target="_self">pmsx003_data_s</a></td><td class="desc">Pmsx003 data structure definition </td></tr>
94-
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpmsx003__handle__s.html" target="_self">pmsx003_handle_s</a></td><td class="desc">Pmsx003 handle structure definition </td></tr>
100+
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpmsx003__handle__s.html" target="_self">pmsx003_handle_s</a></td><td class="desc">Pmsx003 handle structure definition </td></tr>
95101
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpmsx003__info__s.html" target="_self">pmsx003_info_s</a></td><td class="desc">Pmsx003 information structure definition </td></tr>
96102
</table>
97103
</div><!-- directory -->
98104
</div><!-- contents -->
99105
</div><!-- doc-content -->
106+
</div><!-- container -->
100107
<!-- start footer part -->
101108
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
102109
<ul>
103-
<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.1 </li>
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.15.0 </li>
104111
</ul>
105112
</div>
106113
</body>

doc/html/bc_s.png

-676 Bytes
Binary file not shown.

doc/html/bdwn.png

-147 Bytes
Binary file not shown.

doc/html/classes.html

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,57 @@
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"/>
5-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.15.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>LibDriver PMSX003: Data Structure Index</title>
9+
<link rel="icon" href="favicon.svg" type="image/x-icon" />
910
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1011
<script type="text/javascript" src="jquery.js"></script>
1112
<script type="text/javascript" src="dynsections.js"></script>
13+
<script type="text/javascript" src="clipboard.js"></script>
1214
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13-
<script type="text/javascript" src="resize.js"></script>
1415
<script type="text/javascript" src="navtreedata.js"></script>
1516
<script type="text/javascript" src="navtree.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
1618
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1719
<script type="text/javascript" src="search/searchdata.js"></script>
1820
<script type="text/javascript" src="search/search.js"></script>
21+
<script type="text/javascript" src="darkmode_toggle.js"></script>
1922
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2023
</head>
2124
<body>
2225
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
2326
<div id="titlearea">
2427
<table cellspacing="0" cellpadding="0">
2528
<tbody>
26-
<tr style="height: 56px;">
29+
<tr id="projectrow">
2730
<td id="projectlogo"><img alt="Logo" src="doxygen.png"/></td>
28-
<td id="projectalign" style="padding-left: 0.5em;">
31+
<td id="projectalign">
2932
<div id="projectname">LibDriver PMSX003
30-
&#160;<span id="projectnumber">1.0.0</span>
3133
</div>
32-
<div id="projectbrief">PMSX003 full-featured driver</div>
3334
</td>
3435
</tr>
3536
</tbody>
3637
</table>
3738
</div>
3839
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.9.1 -->
40+
<!-- Generated by Doxygen 1.15.0 -->
4041
<script type="text/javascript">
41-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
43-
/* @license-end */
42+
var searchBox = new SearchBox("searchBox", "search/",'.html');
43+
</script>
44+
<script type="text/javascript">
45+
$(function() { codefold.init(); });
4446
</script>
4547
<script type="text/javascript" src="menudata.js"></script>
4648
<script type="text/javascript" src="menu.js"></script>
4749
<script type="text/javascript">
48-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4950
$(function() {
50-
initMenu('',true,false,'search.php','Search');
51-
$(document).ready(function() { init_search(); });
51+
initMenu('',true,false,'search.php','Search',true);
52+
$(function() { init_search(); });
5253
});
53-
/* @license-end */</script>
54+
</script>
5455
<div id="main-nav"></div>
5556
</div><!-- top -->
5657
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -64,10 +65,9 @@
6465
</div>
6566
</div>
6667
<script type="text/javascript">
67-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
68-
$(document).ready(function(){initNavTree('classes.html',''); initResizable(); });
69-
/* @license-end */
68+
$(function(){initNavTree('classes.html','',''); });
7069
</script>
70+
<div id="container">
7171
<div id="doc-content">
7272
<!-- window showing the filter options -->
7373
<div id="MSearchSelectWindow"
@@ -78,28 +78,35 @@
7878

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

8693
<div class="header">
87-
<div class="headertitle">
88-
<div class="title">Data Structure Index</div> </div>
94+
<div class="headertitle"><div class="title">Data Structure Index</div></div>
8995
</div><!--header-->
9096
<div class="contents">
9197
<div class="qindex"><a class="qindex" href="#letter_P">P</a></div>
9298
<div class="classindex">
9399
<dl class="classindex even">
94-
<dt class="alphachar"><a name="letter_P">P</a></dt>
100+
<dt class="alphachar"><a id="letter_P" name="letter_P">P</a></dt>
95101
<dd><a class="el" href="structpmsx003__data__s.html">pmsx003_data_s</a></dd><dd><a class="el" href="structpmsx003__handle__s.html">pmsx003_handle_s</a></dd><dd><a class="el" href="structpmsx003__info__s.html">pmsx003_info_s</a></dd></dl>
96102
</div>
97103
</div><!-- contents -->
98104
</div><!-- doc-content -->
105+
</div><!-- container -->
99106
<!-- start footer part -->
100107
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
101108
<ul>
102-
<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.1 </li>
109+
<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.15.0 </li>
103110
</ul>
104111
</div>
105112
</body>

doc/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+
})

doc/html/closed.png

-132 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)