Update doxygen files

Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>

Author: SRGDamia1

.gitignore

@@ -170,3 +170,8 @@ clang-format-all.py
 installWorkingDependencies.bat
 run_mcss.bat
 pio_common_libdeps.ini
+Ubuntu-Bold.ttf
+docs/clipboard.js
+docs/enviroDIY_favicon.png
+docs/css/m-EnviroDIY+documentation.compiled.css
+docs/examples.dox

README.md

@@ -1,4 +1,4 @@
-# SensorModbusMaster<!-- {#mainpage} -->
+# SensorModbusMaster<!--! {#mainpage} -->
 
 This library is designed to use an Arduino as a Modbus master to communicate with a sensor/slave via the [Modbus RTU](https://en.wikipedia.org/wiki/Modbus) communication protocol.
 It's specifically written with lots of "higher-level" functions to help out users who are largely unfamiliar with the Modbus protocol and want an easy way to get information from a Modbus device.

docs/Doxyfile

@@ -1,4 +1,4 @@
-# Examples Using SensorModbusMaster<!-- {#page_the_examples} -->
+# Examples Using SensorModbusMaster<!--! {#page_the_examples} -->
 
 These example programs demonstrate how to use the SensorModbusMaster library.
 
@@ -16,14 +16,14 @@ ___
 
 [//]: # ( @m_footernavigation )
 
-## Reading and Writing Registers<!-- {#examples_read_write_register} -->
+## Reading and Writing Registers<!--! {#examples_read_write_register} -->
 
 This example writes a setting value to a holding register, reads it to confirm the value has changed, and then reads several data values from holding registers.
 
 - [Instructions for the reading and writing example](https://envirodiy.github.io/SensorModbusMaster/example_read_write_register.html)
 - [The reading and writing example on GitHub](https://github.com/EnviroDIY/SensorModbusMaster/tree/master/examples/readWriteRegister)
 
-## Scanning Registers<!-- {#examples_scan_registers} -->
+## Scanning Registers<!--! {#examples_scan_registers} -->
 
 This is a testing program to scan through all possible holding registers.
 This was written to try to guess the structure of the modbus registers when a map isn't available.

examples/ReadMe.md

@@ -1,4 +1,4 @@
-# Getting and Setting a Modbus Address<!-- {#example_read_write_register} -->
+# Getting and Setting a Modbus Address<!--! {#example_get_set_address} -->
 
 This example gets the Modbus address for a sensor and optionally
 sets it to a new address. This example can be used on sensors from

examples/getSetAddress/ReadMe.md

@@ -8,7 +8,7 @@
  * sets it to a new address. This example can be used on sensors from
  * any manufacturer, as long as you know the register for the device address.
  *
- * @m_examplenavigation{example_read_write_register,}
+ * @m_examplenavigation{example_get_set_address,}
  * @m_footernavigation
  * ======================================================================= */
 

examples/getSetAddress/getSetAddress.ino

@@ -1,4 +1,4 @@
-# Reading and Writing Registers<!-- {#example_read_write_register} -->
+# Reading and Writing Registers<!--! {#example_read_write_register} -->
 
 This example writes a setting value to a holding register, reads it to confirm the value has changed, and then reads several data values from holding registers.
 

examples/readWriteRegister/ReadMe.md

@@ -1,4 +1,4 @@
-# Scanning Registers<!-- {#example_scan_registers} -->
+# Scanning Registers<!--! {#example_scan_registers} -->
 
 This is a testing program to scan through all possible holding registers.
 This was written to try to guess the structure of the modbus registers when a map isn't available.

examples/scanRegisters/ReadMe.md

@@ -1,4 +1,4 @@
-# Hardware for using ModbusRTU with RS-485 on Arduino<!-- {#page_hardware} -->
+# Hardware for using ModbusRTU with RS-485 on Arduino<!--! {#page_hardware} -->
 
 > [!NOTE]
 > Hardware designs have been moved to the [Mayfly-Modbus-Wing](https://github.com/EnviroDIY/Mayfly-Modbus-Wing) repo!

hardware/README.md

@@ -622,6 +622,7 @@ class modbusMaster {
      *
      * @param startInput The starting input number.
      * @param numInputs The number of discrete inputs to read.
+     * @param buff A pre-allocated buffer to store the retrieved coil values.
      * @return True if the modbus slave returned the expected number of input
      * values; false if there was a failure.
      */