fix: Fixed several issues with the new generated-documentation.

apache · Feb 14, 2024 · 2ab1795 · 2ab1795
1 parent f7a6a34
commit 2ab1795
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/plc4j/drivers/all/src/site/generated/ads.adoc b/plc4j/drivers/all/src/site/generated/ads.adoc
@@ -35,9 +35,9 @@
 |Supported Transports 4+|
  - `tcp`
 5+|Config options:
-|`target-ams-net-id` |STRING | |required |AMS-Net-Id of the target.
+|`target-ams-net-id` |STRING | |required |AMS-Net-Id of the target. An AMS-Net-Id has the regular format of an IPv4 IP-Address, however with 6 segments instead of 4.
 |`target-ams-port` |INT | |required |AMS port of the target.
-|`source-ams-net-id` |STRING | |required |AMS-Net-Id of the source.
+|`source-ams-net-id` |STRING | |required |AMS-Net-Id of the source. An AMS-Net-Id has the regular format of an IPv4 IP-Address, however with 6 segments instead of 4.
 |`source-ams-port` |INT | |required |AMS port of the source.
 |`timeout-request` |INT |4000| |Default timeout for all types of requests.
 |`load-symbol-and-data-type-tables` |BOOLEAN |true| |Configures, if when connecting the data-type- and symbol-table should be read. This is an optimization that can help in cases, where the PLC program is pretty large and downloading the full tables is causing problems. When disabled, symbolic addresses will manually be resolved as soon as an address is used.

diff --git a/plc4j/drivers/all/src/site/generated/logix.adoc b/plc4j/drivers/all/src/site/generated/logix.adoc
@@ -35,7 +35,7 @@
 |Supported Transports 4+|
  - `tcp`
 5+|Config options:
-|`communication-path` |STRING | | |The communication path allows for connection routing across multiple backplanes. It uses a common format found in logix controllers.
+|`communication-path` |STRING | | |The communication path allows for connection routing across multiple backplanes. It uses a common format found in Logix controllers.
 It consists of pairs of values, each pair begins with either 1 (Backplane) or 2 (Ethernet), followed by a slot in the case of a backplane address,
 or if using Ethernet an ip address. e.g. [1,4,2,192.168.0.1,1,1] - Routes to the 4th slot in the first rack, which is a ethernet module, it then connects to the address 192.168.0.1, then finds the module in slot 1.
 |`backplane` |INT | | |Without using routing information the backplane defaults to 1. This is overridden if communicationPath is provided.