Moved documentation and fixed version number

thomasfredericks · Jul 19, 2018 · 32c1c48 · 32c1c48
1 parent 5a13202
commit 32c1c48
Show file tree

Hide file tree

Showing 101 changed files with 107 additions and 1,224 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -1130,7 +1130,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = docs
+HTML_OUTPUT            = docs/files
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).

diff --git a/docs/annotated_dup.js b/docs/annotated_dup.js
diff --git a/docs/class_bounce.js b/docs/class_bounce.js
diff --git a/docs/deprecated.html b/docs/deprecated.html
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js
diff --git a/docs/files.js b/docs/files.js
diff --git a/docs/_bounce2_8h_source.html → docs/files/_bounce2_8h_source.html b/docs/_bounce2_8h_source.html → docs/files/_bounce2_8h_source.html
diff --git a/docs/annotated.html → docs/files/annotated.html b/docs/annotated.html → docs/files/annotated.html
diff --git a/docs/bc_s.png → docs/files/bc_s.png b/docs/bc_s.png → docs/files/bc_s.png
diff --git a/docs/bdwn.png → docs/files/bdwn.png b/docs/bdwn.png → docs/files/bdwn.png
diff --git a/docs/bounce2buttons_8ino-example.html → docs/files/bounce2buttons_8ino-example.html b/docs/bounce2buttons_8ino-example.html → docs/files/bounce2buttons_8ino-example.html
diff --git a/docs/bounce_8ino-example.html → docs/files/bounce_8ino-example.html b/docs/bounce_8ino-example.html → docs/files/bounce_8ino-example.html
diff --git a/docs/bounce_multiple_8ino-example.html → docs/files/bounce_multiple_8ino-example.html b/docs/bounce_multiple_8ino-example.html → docs/files/bounce_multiple_8ino-example.html
diff --git a/docs/change_8ino-example.html → docs/files/change_8ino-example.html b/docs/change_8ino-example.html → docs/files/change_8ino-example.html
diff --git a/docs/class_bounce-members.html → docs/files/class_bounce-members.html b/docs/class_bounce-members.html → docs/files/class_bounce-members.html
diff --git a/docs/class_bounce.html → docs/files/class_bounce.html b/docs/class_bounce.html → docs/files/class_bounce.html
diff --git a/docs/classes.html → docs/files/classes.html b/docs/classes.html → docs/files/classes.html
diff --git a/docs/closed.png → docs/files/closed.png b/docs/closed.png → docs/files/closed.png
diff --git a/...dir_68267d1309a1af8e8297ef4c3efbcdba.html → ...dir_68267d1309a1af8e8297ef4c3efbcdba.html b/...dir_68267d1309a1af8e8297ef4c3efbcdba.html → ...dir_68267d1309a1af8e8297ef4c3efbcdba.html
diff --git a/docs/doc.png → docs/files/doc.png b/docs/doc.png → docs/files/doc.png
diff --git a/docs/doxygen.css → docs/files/doxygen.css b/docs/doxygen.css → docs/files/doxygen.css
diff --git a/docs/doxygen.png → docs/files/doxygen.png b/docs/doxygen.png → docs/files/doxygen.png
diff --git a/docs/dynsections.js → docs/files/dynsections.js b/docs/dynsections.js → docs/files/dynsections.js
diff --git a/docs/examples.html → docs/files/examples.html b/docs/examples.html → docs/files/examples.html
diff --git a/docs/files.html → docs/files/files.html b/docs/files.html → docs/files/files.html
diff --git a/docs/folderclosed.png → docs/files/folderclosed.png b/docs/folderclosed.png → docs/files/folderclosed.png
diff --git a/docs/folderopen.png → docs/files/folderopen.png b/docs/folderopen.png → docs/files/folderopen.png
diff --git a/docs/functions.html → docs/files/functions.html b/docs/functions.html → docs/files/functions.html
diff --git a/docs/functions_func.html → docs/files/functions_func.html b/docs/functions_func.html → docs/files/functions_func.html
diff --git a/docs/files/index.html b/docs/files/index.html
@@ -0,0 +1,103 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Bounce2: BOUNCE 2</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">Bounce2
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</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">BOUNCE 2 </div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><p>Debouncing library for Arduino and Wiring by Thomas Ouellet Fredericks with contributions from: Eric Lowry, Jim Schimpf, Tom Harkaway, Joachim Krüger and MrGradgrind.</p>
+<p>More about debouncing: <a href="http://en.wikipedia.org/wiki/Debounce#Contact_bounce">http://en.wikipedia.org/wiki/Debounce#Contact_bounce</a></p>
+<p>See the bottom of this page for a basic usage example and the "examples" folder for more.</p>
+<h2>GITHUB PAGE</h2>
+<p><a href="https://github.com/thomasfredericks/Bounce2">https://github.com/thomasfredericks/Bounce2</a></p>
+<h2>DOCUMENTATION</h2>
+<p>The complete class documentation can be found in the "docs" folder or <a href="http://thomasfredericks.github.io/Bounce2/">online here</a>.</p>
+<h1>HAVE A QUESTION?</h1>
+<p>Please post your questions <a href="http://forum.arduino.cc/index.php?topic=266132.0">here</a>.</p>
+<h1>INSTALLATION &amp; DOWNLOAD</h1>
+<p>Install through your software's Library Manager or download the latest version <a href="https://github.com/thomasfredericks/Bounce2/archive/master.zip">here</a> and put the "Bounce2" folder in your "libraries" folder.</p>
+<p>The original version of <a class="el" href="class_bounce.html">Bounce</a> (<a class="el" href="class_bounce.html">Bounce</a> 1) is included in the download but not supported anymore.</p>
+<h1>DEBOUNCE ALGORITHMS (FOR ADVANCED USERS)</h1>
+<h2>STABLE INTERVAL</h2>
+<p>By default, the <a class="el" href="class_bounce.html">Bounce</a> library uses a stable interval to process the debouncing. This is simpler to understand and can cancel unwanted noise.</p>
+<div class="image">
+<img src="https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_stable.png"/>
+</div>
+<h2>LOCK-OUT INTERVAL</h2>
+<p>By defining "#define BOUNCE_LOCK_OUT" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. This method is a lot more responsive, but does not cancel noise.</p>
+<div class="fragment"><div class="line">#define BOUNCE_LOCK_OUT</div></div><!-- fragment --><div class="image">
+<img src="https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_lockout.png"/>
+</div>
+<h2>WITH PROMPT DETECTION</h2>
+<p>By defining "#define BOUNCE_WITH_PROMPT_DETECTION" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. Button state changes are available immediately so long as the previous state has been stable for the timeout period. Otherwise the state will be updated as soon as the timeout period allows.</p>
+<ul>
+<li>Able to report acurate switch time normally with no delay.</li>
+<li>Use when accurate switch transition timing is important.</li>
+</ul>
+<div class="fragment"><div class="line">#define BOUNCE_WITH_PROMPT_DETECTION</div></div><!-- fragment --><h1>BASIC EXAMPLE</h1>
+<div class="fragment"><div class="line"><span class="comment">// This example toggles the debug LED (pin 13) on or off</span></div><div class="line"><span class="comment">// when a button on pin 2 is pressed.</span></div><div class="line"></div><div class="line"><span class="comment">// Include the Bounce2 library found here :</span></div><div class="line"><span class="comment">// https://github.com/thomasfredericks/Bounce2</span></div><div class="line"><span class="preprocessor">#include &lt;Bounce2.h&gt;</span></div><div class="line"></div><div class="line"><span class="preprocessor">#define BUTTON_PIN 2</span></div><div class="line"><span class="preprocessor">#define LED_PIN 13</span></div><div class="line"></div><div class="line"><span class="keywordtype">int</span> ledState = LOW;</div><div class="line"></div><div class="line"></div><div class="line"><a class="code" href="class_bounce.html">Bounce</a> debouncer = <a class="code" href="class_bounce.html">Bounce</a>(); <span class="comment">// Instantiate a Bounce object</span></div><div class="line"></div><div class="line"><span class="keywordtype">void</span> setup() {</div><div class="line"></div><div class="line">  debouncer.<a class="code" href="class_bounce.html#aba08e592941465d033e3eba3dde66eaf">attach</a>(BUTTON_PIN,INPUT_PULLUP); <span class="comment">// Attach the debouncer to a pin with INPUT_PULLUP mode</span></div><div class="line">  debouncer.<a class="code" href="class_bounce.html#a2c6e68bf749497c597a9437b488b3d7c">interval</a>(25); <span class="comment">// Use a debounce interval of 25 milliseconds</span></div><div class="line"></div><div class="line"></div><div class="line">  pinMode(LED_PIN,OUTPUT); <span class="comment">// Setup the LED</span></div><div class="line">  digitalWrite(LED_PIN,ledState);</div><div class="line"></div><div class="line">}</div><div class="line"></div><div class="line"><span class="keywordtype">void</span> loop() {</div><div class="line"></div><div class="line">   debouncer.<a class="code" href="class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441">update</a>(); <span class="comment">// Update the Bounce instance</span></div><div class="line"></div><div class="line">   <span class="keywordflow">if</span> ( debouncer.<a class="code" href="class_bounce.html#abfbb0910f5b1ec4e25315cff26dd6289">fell</a>() ) {  <span class="comment">// Call code if button transitions from HIGH to LOW</span></div><div class="line">     ledState = !ledState; <span class="comment">// Toggle LED state</span></div><div class="line">     digitalWrite(LED_PIN,ledState); <span class="comment">// Apply new LED state</span></div><div class="line">   }</div><div class="line">}</div></div><!-- fragment --> </div></div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>
diff --git a/docs/jquery.js → docs/files/jquery.js b/docs/jquery.js → docs/files/jquery.js
diff --git a/docs/menu.js → docs/files/menu.js b/docs/menu.js → docs/files/menu.js
diff --git a/docs/menudata.js → docs/files/menudata.js b/docs/menudata.js → docs/files/menudata.js
diff --git a/docs/nav_f.png → docs/files/nav_f.png b/docs/nav_f.png → docs/files/nav_f.png
diff --git a/docs/nav_g.png → docs/files/nav_g.png b/docs/nav_g.png → docs/files/nav_g.png
diff --git a/docs/nav_h.png → docs/files/nav_h.png b/docs/nav_h.png → docs/files/nav_h.png
diff --git a/docs/open.png → docs/files/open.png b/docs/open.png → docs/files/open.png
diff --git a/docs/search/all_0.html → docs/files/search/all_0.html b/docs/search/all_0.html → docs/files/search/all_0.html
diff --git a/docs/search/all_0.js → docs/files/search/all_0.js b/docs/search/all_0.js → docs/files/search/all_0.js
diff --git a/docs/search/all_1.html → docs/files/search/all_1.html b/docs/search/all_1.html → docs/files/search/all_1.html
diff --git a/docs/search/all_1.js → docs/files/search/all_1.js b/docs/search/all_1.js → docs/files/search/all_1.js
diff --git a/docs/search/all_2.html → docs/files/search/all_2.html b/docs/search/all_2.html → docs/files/search/all_2.html
diff --git a/docs/search/all_2.js → docs/files/search/all_2.js b/docs/search/all_2.js → docs/files/search/all_2.js
diff --git a/docs/search/all_3.html → docs/files/search/all_3.html b/docs/search/all_3.html → docs/files/search/all_3.html
diff --git a/docs/search/all_3.js → docs/files/search/all_3.js b/docs/search/all_3.js → docs/files/search/all_3.js
diff --git a/docs/search/all_4.html → docs/files/search/all_4.html b/docs/search/all_4.html → docs/files/search/all_4.html
diff --git a/docs/search/all_4.js → docs/files/search/all_4.js b/docs/search/all_4.js → docs/files/search/all_4.js
diff --git a/docs/search/all_5.html → docs/files/search/all_5.html b/docs/search/all_5.html → docs/files/search/all_5.html
diff --git a/docs/search/all_5.js → docs/files/search/all_5.js b/docs/search/all_5.js → docs/files/search/all_5.js
diff --git a/docs/search/all_6.html → docs/files/search/all_6.html b/docs/search/all_6.html → docs/files/search/all_6.html
diff --git a/docs/search/all_6.js → docs/files/search/all_6.js b/docs/search/all_6.js → docs/files/search/all_6.js
diff --git a/docs/search/classes_0.html → docs/files/search/classes_0.html b/docs/search/classes_0.html → docs/files/search/classes_0.html
diff --git a/docs/search/classes_0.js → docs/files/search/classes_0.js b/docs/search/classes_0.js → docs/files/search/classes_0.js
diff --git a/docs/search/close.png → docs/files/search/close.png b/docs/search/close.png → docs/files/search/close.png
diff --git a/docs/search/functions_0.html → docs/files/search/functions_0.html b/docs/search/functions_0.html → docs/files/search/functions_0.html
diff --git a/docs/search/functions_0.js → docs/files/search/functions_0.js b/docs/search/functions_0.js → docs/files/search/functions_0.js
diff --git a/docs/search/functions_1.html → docs/files/search/functions_1.html b/docs/search/functions_1.html → docs/files/search/functions_1.html
diff --git a/docs/search/functions_1.js → docs/files/search/functions_1.js b/docs/search/functions_1.js → docs/files/search/functions_1.js
diff --git a/docs/search/functions_2.html → docs/files/search/functions_2.html b/docs/search/functions_2.html → docs/files/search/functions_2.html
diff --git a/docs/search/functions_2.js → docs/files/search/functions_2.js b/docs/search/functions_2.js → docs/files/search/functions_2.js
diff --git a/docs/search/functions_3.html → docs/files/search/functions_3.html b/docs/search/functions_3.html → docs/files/search/functions_3.html
diff --git a/docs/search/functions_3.js → docs/files/search/functions_3.js b/docs/search/functions_3.js → docs/files/search/functions_3.js
diff --git a/docs/search/functions_4.html → docs/files/search/functions_4.html b/docs/search/functions_4.html → docs/files/search/functions_4.html
diff --git a/docs/search/functions_4.js → docs/files/search/functions_4.js b/docs/search/functions_4.js → docs/files/search/functions_4.js
diff --git a/docs/search/functions_5.html → docs/files/search/functions_5.html b/docs/search/functions_5.html → docs/files/search/functions_5.html
diff --git a/docs/search/functions_5.js → docs/files/search/functions_5.js b/docs/search/functions_5.js → docs/files/search/functions_5.js
diff --git a/docs/search/functions_6.html → docs/files/search/functions_6.html b/docs/search/functions_6.html → docs/files/search/functions_6.html
diff --git a/docs/search/functions_6.js → docs/files/search/functions_6.js b/docs/search/functions_6.js → docs/files/search/functions_6.js
diff --git a/docs/search/mag_sel.png → docs/files/search/mag_sel.png b/docs/search/mag_sel.png → docs/files/search/mag_sel.png
diff --git a/docs/search/nomatches.html → docs/files/search/nomatches.html b/docs/search/nomatches.html → docs/files/search/nomatches.html
diff --git a/docs/search/pages_0.html → docs/files/search/pages_0.html b/docs/search/pages_0.html → docs/files/search/pages_0.html
diff --git a/docs/search/pages_0.js → docs/files/search/pages_0.js b/docs/search/pages_0.js → docs/files/search/pages_0.js
diff --git a/docs/search/search.css → docs/files/search/search.css b/docs/search/search.css → docs/files/search/search.css
diff --git a/docs/search/search.js → docs/files/search/search.js b/docs/search/search.js → docs/files/search/search.js
diff --git a/docs/search/search_l.png → docs/files/search/search_l.png b/docs/search/search_l.png → docs/files/search/search_l.png
diff --git a/docs/search/search_m.png → docs/files/search/search_m.png b/docs/search/search_m.png → docs/files/search/search_m.png
diff --git a/docs/search/search_r.png → docs/files/search/search_r.png b/docs/search/search_r.png → docs/files/search/search_r.png
diff --git a/docs/search/searchdata.js → docs/files/search/searchdata.js b/docs/search/searchdata.js → docs/files/search/searchdata.js
diff --git a/docs/splitbar.png → docs/files/splitbar.png b/docs/splitbar.png → docs/files/splitbar.png
diff --git a/docs/sync_off.png → docs/files/sync_off.png b/docs/sync_off.png → docs/files/sync_off.png
diff --git a/docs/sync_on.png → docs/files/sync_on.png b/docs/sync_on.png → docs/files/sync_on.png
diff --git a/docs/tab_a.png → docs/files/tab_a.png b/docs/tab_a.png → docs/files/tab_a.png
diff --git a/docs/tab_b.png → docs/files/tab_b.png b/docs/tab_b.png → docs/files/tab_b.png
diff --git a/docs/tab_h.png → docs/files/tab_h.png b/docs/tab_h.png → docs/files/tab_h.png
diff --git a/docs/tab_s.png → docs/files/tab_s.png b/docs/tab_s.png → docs/files/tab_s.png
diff --git a/docs/tabs.css → docs/files/tabs.css b/docs/tabs.css → docs/files/tabs.css