feat: add doxygen

FlorianFrank · Jun 24, 2021 · 8def8c2 · 8def8c2
1 parent b400520
commit 8def8c2
Show file tree

Hide file tree

Showing 169 changed files with 17,781 additions and 18 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,7 @@
 build
 out
-html
-latex
 cmake-build-debug
 cmake-build-release
 cmake-build-relwithdebinfo
 .idea
+.DS_Store
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -25,4 +25,4 @@ install(DIRECTORY src/
         FILES_MATCHING PATTERN "*.h"
         )
 
-# add_subdirectory(test)
+add_subdirectory(test)
diff --git a/Doxyfile b/Doxyfile
diff --git a/... and specs/Keysight_InfiniiVision3000.pdf → ..._and_specs/Keysight_InfiniiVision3000.pdf b/... and specs/Keysight_InfiniiVision3000.pdf → ..._and_specs/Keysight_InfiniiVision3000.pdf
diff --git a/...pecs/SPD1000X_UserManual_UM0501X-E02A.pdf → ...pecs/SPD1000X_UserManual_UM0501X-E02A.pdf b/...pecs/SPD1000X_UserManual_UM0501X-E02A.pdf → ...pecs/SPD1000X_UserManual_UM0501X-E02A.pdf
diff --git a/docs and specs/Voltage Measurement Lib.pdf → docs_and_specs/Voltage Measurement Lib.pdf b/docs and specs/Voltage Measurement Lib.pdf → docs_and_specs/Voltage Measurement Lib.pdf
diff --git a/docs_and_specs/html/annotated.html b/docs_and_specs/html/annotated.html
@@ -0,0 +1,82 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.9.2"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>ce_device: Class List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">ce_device
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.2 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",'Search','.html');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle"><div class="title">Class List</div></div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
+<table class="directory">
+<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="class_device.html" target="_self">Device</a></td><td class="desc">Basic device class This class contains all basic method of all devices, like connect, exec, what_am_i etc </td></tr>
+<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="class_k_s_t3000.html" target="_self">KST3000</a></td><td class="desc">Mixed Single Oscilloscope(Oscillator) Commend operations of a single generator are defined. <a class="el" href="class_k_s_t3000.html" title="Mixed Single Oscilloscope(Oscillator) Commend operations of a single generator are defined....">KST3000</a> is the model of the device(keysight 3000 series) </td></tr>
+<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="class_k_s_t33500.html" target="_self">KST33500</a></td><td class="desc"></td></tr>
+<tr id="row_3_"><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="class_s_p_d1305.html" target="_self">SPD1305</a></td><td class="desc"></td></tr>
+</table>
+</div><!-- directory -->
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
+</small></address>
+</body>
+</html>
diff --git a/docs_and_specs/html/bc_s.png b/docs_and_specs/html/bc_s.png
diff --git a/docs_and_specs/html/bdwn.png b/docs_and_specs/html/bdwn.png
diff --git a/docs_and_specs/html/class_device-members.html b/docs_and_specs/html/class_device-members.html
@@ -0,0 +1,91 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.9.2"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>ce_device: Member List</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">ce_device
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.2 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",'Search','.html');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+</div><!-- top -->
+<div class="header">
+  <div class="headertitle"><div class="title">Device Member List</div></div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="class_device.html">Device</a>, including all inherited members.</p>
+<table class="directory">
+  <tr class="even"><td class="entry"><a class="el" href="class_device.html#a6d8f4f486b4ccf48e38f12e251706f7b">cli</a>()</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_device.html#ad2b9f59ad977879bd6314258b2080d27">connect</a>()</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>connect</b>() (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Device</b>(char *ip, unsigned short port) (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_device.html#aa806615b4c41195c9ba4fc16315d3c76">Device</a>(char *ip)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Device</b>(char *ip, unsigned short port) (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Device</b>(char *ip) (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_device.html#aade23adf20b97f22c1039fa02ea2fca9">exec</a>(string message, char *result=nullptr, bool=true)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>exec</b>(string message, char *result=nullptr, bool=true) (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>ip</b> (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>port</b> (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>test</b>() (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>test</b>() (defined in <a class="el" href="class_device.html">Device</a>)</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_device.html#a7b46618094960d42a0fb3bfa71c3e732">what_am_i</a>()</td><td class="entry"><a class="el" href="class_device.html">Device</a></td><td class="entry"></td></tr>
+</table></div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
+</small></address>
+</body>
+</html>