Updated the docs

berndporr · Feb 13, 2024 · ff2038b · ff2038b
1 parent 7bd95a5
commit ff2038b
Show file tree

Hide file tree

Showing 17 changed files with 144 additions and 70 deletions.
diff --git a/docs/CppTimerCallback_8h_source.html b/docs/CppTimerCallback_8h_source.html
@@ -104,11 +104,11 @@
 <div class="ttc" id="aclassCppTimerCallback_1_1Runnable_html"><div class="ttname"><a href="classCppTimerCallback_1_1Runnable.html">CppTimerCallback::Runnable</a></div><div class="ttdef"><b>Definition:</b> CppTimerCallback.h:11</div></div>
 <div class="ttc" id="aclassCppTimerCallback_html"><div class="ttname"><a href="classCppTimerCallback.html">CppTimerCallback</a></div><div class="ttdef"><b>Definition:</b> CppTimerCallback.h:8</div></div>
 <div class="ttc" id="aclassCppTimerCallback_html_af6b39f5eb8e98bfc1b301ac3f25276e9"><div class="ttname"><a href="classCppTimerCallback.html#af6b39f5eb8e98bfc1b301ac3f25276e9">CppTimerCallback::timerEvent</a></div><div class="ttdeci">void timerEvent()</div><div class="ttdef"><b>Definition:</b> CppTimerCallback.h:24</div></div>
-<div class="ttc" id="aclassCppTimer_html"><div class="ttname"><a href="classCppTimer.html">CppTimer</a></div><div class="ttdef"><b>Definition:</b> CppTimer.h:36</div></div>
+<div class="ttc" id="aclassCppTimer_html"><div class="ttname"><a href="classCppTimer.html">CppTimer</a></div><div class="ttdef"><b>Definition:</b> CppTimer.h:34</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/CppTimer_8h_source.html b/docs/CppTimer_8h_source.html
diff --git a/docs/annotated.html b/docs/annotated.html
@@ -75,7 +75,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/classCppTimer-members.html b/docs/classCppTimer-members.html
@@ -68,15 +68,15 @@
 
 <p>This is the complete list of members for <a class="el" href="classCppTimer.html">CppTimer</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a8054cc8cead2e360b06b6ff99cc964cf">startms</a>(long millisecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classCppTimer.html#a7de6bd2c8c9b5daa70d5c3d9b97fa49b">startns</a>(long nanosecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#aafb86e2bb43311bf154867dd6da43e80">stop</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a8054cc8cead2e360b06b6ff99cc964cf">startms</a>(long millisecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classCppTimer.html#a7de6bd2c8c9b5daa70d5c3d9b97fa49b">startns</a>(long nanosecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#aafb86e2bb43311bf154867dd6da43e80">stop</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classCppTimer.html#ac2665403595b6aee5f581d0ebfeb886c">timerEvent</a>()=0</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a2942aab831713273a76218048fe61b16">~CppTimer</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a2942aab831713273a76218048fe61b16">~CppTimer</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/classCppTimer.html b/docs/classCppTimer.html
@@ -118,7 +118,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2942aab831713273a7621804
       </table>
   </td>
   <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">
@@ -156,7 +156,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8054cc8cead2e360b06b6ff9
       </table>
   </td>
   <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">
@@ -199,7 +199,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7de6bd2c8c9b5daa70d5c3d9
       </table>
   </td>
   <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">
@@ -231,7 +231,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aafb86e2bb43311bf154867dd
       </table>
   </td>
   <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">
@@ -273,7 +273,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac2665403595b6aee5f581d0e
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/classCppTimerCallback-members.html b/docs/classCppTimerCallback-members.html
@@ -68,15 +68,15 @@
 
 <p>This is the complete list of members for <a class="el" href="classCppTimerCallback.html">CppTimerCallback</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a8054cc8cead2e360b06b6ff99cc964cf">startms</a>(long millisecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classCppTimer.html#a7de6bd2c8c9b5daa70d5c3d9b97fa49b">startns</a>(long nanosecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#aafb86e2bb43311bf154867dd6da43e80">stop</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a8054cc8cead2e360b06b6ff99cc964cf">startms</a>(long millisecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classCppTimer.html#a7de6bd2c8c9b5daa70d5c3d9b97fa49b">startns</a>(long nanosecs, cppTimerType_t type=PERIODIC)</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#aafb86e2bb43311bf154867dd6da43e80">stop</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classCppTimerCallback.html#af6b39f5eb8e98bfc1b301ac3f25276e9">timerEvent</a>()</td><td class="entry"><a class="el" href="classCppTimerCallback.html">CppTimerCallback</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a2942aab831713273a76218048fe61b16">~CppTimer</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCppTimer.html#a2942aab831713273a76218048fe61b16">~CppTimer</a>()</td><td class="entry"><a class="el" href="classCppTimer.html">CppTimer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/classCppTimerCallback.html b/docs/classCppTimerCallback.html
@@ -136,7 +136,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af6b39f5eb8e98bfc1b301ac3
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/classCppTimerCallback_1_1Runnable-members.html b/docs/classCppTimerCallback_1_1Runnable-members.html
@@ -74,7 +74,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/classCppTimerCallback_1_1Runnable.html b/docs/classCppTimerCallback_1_1Runnable.html
@@ -77,7 +77,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/classes.html b/docs/classes.html
@@ -77,7 +77,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/files.html b/docs/files.html
@@ -74,7 +74,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/functions.html b/docs/functions.html
@@ -82,7 +82,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/functions_func.html b/docs/functions_func.html
@@ -82,7 +82,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
@@ -75,7 +75,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/index.html b/docs/index.html
@@ -68,7 +68,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/md_README.html b/docs/md_README.html
@@ -75,7 +75,7 @@ <h1><a class="anchor" id="autotoc_md1"></a>
 </div><!-- fragment --><h1><a class="anchor" id="autotoc_md2"></a>
 Usage (overloading the timer event)</h1>
 <p>The doxygen generated online docs are here: <a href="https://berndporr.github.io/cppTimer/">https://berndporr.github.io/cppTimer/</a></p>
-<p>Include <code><a class="el" href="CppTimer_8h_source.html">CppTimer.h</a></code> in your program and link the static library <code>libcpptimer.a</code> to your project: </p><div class="fragment"><div class="line">TARGET_LINK_LIBRARIES(your_project_title cpptimer rt)</div>
+<p>Include <code><a class="el" href="CppTimer_8h_source.html">CppTimer.h</a></code> in your program. That's it. </p><div class="fragment"><div class="line">TARGET_LINK_LIBRARIES(your_project_title cpptimer rt)</div>
 </div><!-- fragment --><h2><a class="anchor" id="autotoc_md3"></a>
 Create the Timer class</h2>
 <div class="fragment"><div class="line">class MyTimer : public CppTimer {</div>
@@ -108,7 +108,7 @@ <h1><a class="anchor" id="autotoc_md7"></a>
 </div><!-- PageDoc -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>
diff --git a/docs/pages.html b/docs/pages.html
@@ -73,7 +73,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Sat Jan 27 2024 23:55:50 for CppTimer 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.1
+Generated on Tue Feb 13 2024 10:43:24 for CppTimer 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.1
 </small></address>
 </body>
 </html>