Skip to content

Commit 42bef1d

Browse files
committed
Use newer doxygen html comment config
Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
1 parent 3d5cc04 commit 42bef1d

File tree

6 files changed

+22
-21
lines changed

6 files changed

+22
-21
lines changed

ChangeLog.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
1818

1919
- Added extra functions specifying "holding" or "input" in the function name.
2020
- Added the ability to change the number of times to retry commands.
21+
- Added the ability to change the command and frame timeouts.
2122
- Added an enum for modbus error codes.
2223
- Added a variable to store the last error code, which can be checked with `getLastError()` and printed with `printLastError()`.
2324

@@ -239,4 +240,4 @@ This information can now be found in its [own repository](https://github.com/Env
239240
[0.1.2]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.1.2
240241
[0.1.0]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.1.0
241242

242-
[//]: # ( @m_footernavigation )
243+
<!--! @m_footernavigation -->

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
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.
44
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.
55

6-
[//]: # ( @tableofcontents )
6+
<!--! @tableofcontents -->
77

8-
[//]: # ( @m_footernavigation )
8+
<!--! @m_footernavigation -->
99

10-
[//]: # ( Start GitHub Only )
10+
<!--! @if GITHUB -->
1111

1212
- [SensorModbusMaster](#sensormodbusmaster)
1313
- [Using the library](#using-the-library)
@@ -16,7 +16,7 @@ It's specifically written with lots of "higher-level" functions to help out user
1616
- [Notes on TTL and RS485/RS322 electrical communications standards](#notes-on-ttl-and-rs485rs322-electrical-communications-standards)
1717
- [Hardware interface suggestions for EnviroDIY Mayfly](#hardware-interface-suggestions-for-envirodiy-mayfly)
1818

19-
[//]: # ( End GitHub Only )
19+
<!--! @endif -->
2020
_____
2121

2222
## Using the library

examples/ReadMe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ These example programs demonstrate how to use the SensorModbusMaster library.
44

55
___
66

7-
[//]: # ( Start GitHub Only )
7+
<!--! @if GITHUB -->
88

99
- [Examples Using SensorModbusMaster](#examples-using-sensormodbusmaster)
1010
- [Reading and Writing Registers](#reading-and-writing-registers)
1111
- [Scanning Registers](#scanning-registers)
1212

13-
[//]: # ( End GitHub Only )
13+
<!--! @endif -->
1414

15-
[//]: # ( @tableofcontents )
15+
<!--! @tableofcontents -->
1616

17-
[//]: # ( @m_footernavigation )
17+
<!--! @m_footernavigation -->
1818

1919
## Reading and Writing Registers<!--! {#examples_read_write_register} -->
2020

examples/getSetAddress/ReadMe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ any manufacturer, as long as you know the register for the device address.
66

77
_______
88

9-
[//]: # ( @section example_get_set_address_pio_config PlatformIO Configuration )
9+
<!--! @section example_get_set_address_pio_config PlatformIO Configuration -->
1010

11-
[//]: # ( @include{lineno} getSetAddress/platformio.ini )
11+
<!--! @include{lineno} getSetAddress/platformio.ini -->
1212

13-
[//]: # ( @section example_get_set_address_pio_code The Complete Code )
13+
<!--! @section example_get_set_address_pio_code The Complete Code -->
1414

15-
[//]: # ( @include{lineno} getSetAddress/getSetAddress.ino )
15+
<!--! @include{lineno} getSetAddress/getSetAddress.ino -->

examples/readWriteRegister/ReadMe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This example writes a setting value to a holding register, reads it to confirm t
44

55
_______
66

7-
[//]: # ( @section example_read_write_register_pio_config PlatformIO Configuration )
7+
<!--! @section example_read_write_register_pio_config PlatformIO Configuration -->
88

9-
[//]: # ( @include{lineno} readWriteRegister/platformio.ini )
9+
<!--! @include{lineno} readWriteRegister/platformio.ini -->
1010

11-
[//]: # ( @section example_read_write_register_code The Complete Code )
11+
<!--! @section example_read_write_register_code The Complete Code -->
1212

13-
[//]: # ( @include{lineno} readWriteRegister/readWriteRegister.ino )
13+
<!--! @include{lineno} readWriteRegister/readWriteRegister.ino -->

examples/scanRegisters/ReadMe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ This was written to try to guess the structure of the modbus registers when a ma
66
_______
77

88

9-
[//]: # ( @section example_scan_registers_pio_config PlatformIO Configuration )
9+
<!--! @section example_scan_registers_pio_config PlatformIO Configuration -->
1010

11-
[//]: # ( @include{lineno} scanRegisters/platformio.ini )
11+
<!--! @include{lineno} scanRegisters/platformio.ini -->
1212

13-
[//]: # ( @section example_scan_registers_code The Complete Code )
13+
<!--! @section example_scan_registers_code The Complete Code -->
1414

15-
[//]: # ( @include{lineno} scanRegisters/scanRegisters.ino )
15+
<!--! @include{lineno} scanRegisters/scanRegisters.ino -->

0 commit comments

Comments
 (0)