doxy docs updated

Author: ftjuh

Doxyfile.bak

@@ -14,6 +14,8 @@ Download I2Cwrapper [on github.](https://github.com/ftjuh/I2Cwrapper)
 
 The I2Cwrapper library and the module libraries  [are documented here](https://ftjuh.github.io/I2Cwrapper/index.html).
 
+See [Usage](#usage) for a quick start.
+
 ## Ready to use modules
 
 Currently, the following modules come shipped with I2Cwrapper in the [firmware subfolder](https://github.com/ftjuh/I2Cwrapper/tree/main/firmware) (see [Available modules](#available-modules) for more detailed information):
@@ -76,6 +78,7 @@ The other two basic components are for the **I2C controller's side**:
    - The **I2C buffer size** used by I2Cwrapper objects defaults to 20 bytes. The CRC checksum takes 1 byte, the command header for transmissions from controller to the target take 2 bytes. That leaves 17 bytes as maximum parameter payload for commands and 19 bytes for target responses. A more flexible approach is planned for a future release. Note for ATtiny: depending on the Wire library selected by ATtinyCore, the maximum usable buffer size might even be smaller, see [supported platforms](#supported-platforms))
 
 See the [How to add new modules](#how-to-add-new-modules) section if you are interested in writing a new module and implementing your own target device.
+<a id="usage"></a>
 
 # Usage
 

README.md

@@ -89,10 +89,10 @@
 </div><!--header-->
 <div class="contents">
 
-<p>Define a fixed address for the target.  
+<p>Feature module. Defines a fixed address, other than the default 0x08, for the target.  
 <a href="#details">More...</a></p>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p >Define a fixed address for the target. </p>
+<div class="textblock"><p >Feature module. Defines a fixed address, other than the default 0x08, for the target. </p>
 <h2><a class="anchor" id="autotoc_md0"></a>
 Author</h2>
 <p >Copyright (c) 2022 juh </p>
@@ -105,7 +105,7 @@ <h2><a class="anchor" id="autotoc_md1"></a>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li><li class="navelem"><a class="el" href="__address_fixed__firmware_8h.html">_addressFixed_firmware.h</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>

docs/__address_fixed__firmware_8h.html

@@ -89,10 +89,10 @@
 </div><!--header-->
 <div class="contents">
 
-<p>Read target's own I2C address from non volatile memory (EEPROM, flash memory) and store a new changed address upon the controller's command.  
+<p>Feature module. Read target's own I2C address from non volatile memory (EEPROM, flash memory) and store a new changed address upon the controller's command.  
 <a href="#details">More...</a></p>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p >Read target's own I2C address from non volatile memory (EEPROM, flash memory) and store a new changed address upon the controller's command. </p>
+<div class="textblock"><p >Feature module. Read target's own I2C address from non volatile memory (EEPROM, flash memory) and store a new changed address upon the controller's command. </p>
 <h2><a class="anchor" id="autotoc_md2"></a>
 Author</h2>
 <p >Copyright (c) 2022 juh </p>
@@ -105,7 +105,7 @@ <h2><a class="anchor" id="autotoc_md3"></a>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li><li class="navelem"><a class="el" href="__address_from_flash__firmware_8h.html">_addressFromFlash_firmware.h</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>

docs/__address_from_flash__firmware_8h.html

@@ -89,10 +89,10 @@
 </div><!--header-->
 <div class="contents">
 
-<p>Makes the target retrieve its own address from the input state of one or more pins at startup, so that the end user can change it e.g. with solder bridges or DIP switches. To adapt for your specific needs, you'll have to change the following values below:  
+<p>Feature module. Makes the target retrieve its own address from the input state of one or more pins at startup, so that the end user can change it e.g. with solder bridges or DIP switches. To adapt for your specific needs, you'll have to change the following values below:  
 <a href="#details">More...</a></p>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p >Makes the target retrieve its own address from the input state of one or more pins at startup, so that the end user can change it e.g. with solder bridges or DIP switches. To adapt for your specific needs, you'll have to change the following values below: </p>
+<div class="textblock"><p >Feature module. Makes the target retrieve its own address from the input state of one or more pins at startup, so that the end user can change it e.g. with solder bridges or DIP switches. To adapt for your specific needs, you'll have to change the following values below: </p>
 <ul>
 <li>I2CaddressOffset - base address when all pins are inactive</li>
 <li>I2CaddressPins - array of 1 to 7 pins, LSB pin first</li>
@@ -111,7 +111,7 @@ <h2><a class="anchor" id="autotoc_md5"></a>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li><li class="navelem"><a class="el" href="__address_from_pins__firmware_8h.html">_addressFromPins_firmware.h</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>

docs/__address_from_pins__firmware_8h.html

@@ -89,10 +89,10 @@
 </div><!--header-->
 <div class="contents">
 
-<p>Feature module that makes the LED_BUILTIN flash on incoming interrupts (receiveEvent and requestEvent). Meant mainly as a still-alive monitor. To make it flash on I2C state machine state changes, (un)comment the respective lines below in secitions (7), (8) and (9) If your board has no LED_BUILTIN, make sure to edit the proper pin number in the declaration stage below..  
+<p>Feature module. Makes the LED_BUILTIN flash on incoming interrupts (receiveEvent and requestEvent). Meant mainly as a still-alive monitor. To make it flash on I2C state machine state changes, (un)comment the respective lines below in secitions (7), (8) and (9) If your board has no LED_BUILTIN, make sure to edit the proper pin number in the declaration stage below..  
 <a href="#details">More...</a></p>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p >Feature module that makes the LED_BUILTIN flash on incoming interrupts (receiveEvent and requestEvent). Meant mainly as a still-alive monitor. To make it flash on I2C state machine state changes, (un)comment the respective lines below in secitions (7), (8) and (9) If your board has no LED_BUILTIN, make sure to edit the proper pin number in the declaration stage below.. </p>
+<div class="textblock"><p >Feature module. Makes the LED_BUILTIN flash on incoming interrupts (receiveEvent and requestEvent). Meant mainly as a still-alive monitor. To make it flash on I2C state machine state changes, (un)comment the respective lines below in secitions (7), (8) and (9) If your board has no LED_BUILTIN, make sure to edit the proper pin number in the declaration stage below.. </p>
 <h2><a class="anchor" id="autotoc_md6"></a>
 Author</h2>
 <p >Copyright (c) 2022 juh </p>
@@ -105,7 +105,7 @@ <h2><a class="anchor" id="autotoc_md7"></a>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li><li class="navelem"><a class="el" href="__status_l_e_d__firmware_8h.html">_statusLED_firmware.h</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>

docs/__status_l_e_d__firmware_8h.html

@@ -105,7 +105,7 @@ <h2><a class="anchor" id="autotoc_md47"></a>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_accel_stepper_i2_c_8cpp.html">AccelStepperI2C.cpp</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>

docs/_accel_stepper_i2_c_8cpp.html

@@ -967,7 +967,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a32160df6d26a36100c3d92fc
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_accel_stepper_i2_c_8h.html">AccelStepperI2C.h</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>

docs/_accel_stepper_i2_c_8h.html

@@ -106,7 +106,7 @@ <h2><a class="anchor" id="autotoc_md9"></a>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d9edf6c004b4a7ff14fe9ae7a92214ee.html">firmware</a></li><li class="navelem"><a class="el" href="_accel_stepper_i2_c__firmware_8h.html">AccelStepperI2C_firmware.h</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>

docs/_accel_stepper_i2_c__firmware_8h.html

@@ -180,7 +180,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac4e5a646798b794ce8bf7303
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d28a4824dc47e487b107a5db32ef43c4.html">examples</a></li><li class="navelem"><a class="el" href="dir_a4ee1f513e7bd5a2e1a4b5120766b8ea.html">Adjust_I2Cdelay</a></li><li class="navelem"><a class="el" href="_adjust___i2_cdelay_8ino.html">Adjust_I2Cdelay.ino</a></li>
-    <li class="footer">Generated on Thu Jul 7 2022 21:51:23 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
+    <li class="footer">Generated on Sun Jul 10 2022 11:28:54 for I2Cwrapper by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
   </ul>
 </div>
 </body>