Skip to content

Commit f173563

Browse files
committed
Update docs
1 parent 7a1d9e4 commit f173563

37 files changed

Lines changed: 294 additions & 95 deletions

CMakePresets.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
{
2727
"name": "Win64-MSVC",
2828
"displayName": "Win64 Config Default MSVC",
29-
"description": "Using compilers for Visual Studio 17 2022 (x64 architecture)",
29+
"description": "Using compilers for Visual Studio 18 2026 (x64 architecture)",
3030
"inherits": "Win-Base",
31-
"generator": "Visual Studio 17 2022",
31+
"generator": "Visual Studio 18 2026",
3232
"toolset": "host=x64",
3333
"architecture": "x64",
3434
"binaryDir": "$env{USERPROFILE}/tmp/cmake/ModbusTools/bin/Win64",
@@ -38,7 +38,7 @@
3838
},
3939
{
4040
"name": "Win64-MSVC-Client",
41-
"description": "Win64 Config for Client Only build using compilers for Visual Studio 17 2022 (x64 architecture)",
41+
"description": "Win64 Config for Client Only build using compilers for Visual Studio 18 2026 (x64 architecture)",
4242
"inherits": "Win64-MSVC",
4343
"binaryDir": "$env{USERPROFILE}/tmp/cmake/ModbusTools/bin/Win64-Client",
4444
"cacheVariables": {
@@ -48,7 +48,7 @@
4848
},
4949
{
5050
"name": "Win64-MSVC-Server",
51-
"description": "Win64 Config for Server Only build using compilers for Visual Studio 17 2022 (x64 architecture)",
51+
"description": "Win64 Config for Server Only build using compilers for Visual Studio 18 2026 (x64 architecture)",
5252
"inherits": "Win64-MSVC",
5353
"binaryDir": "$env{USERPROFILE}/tmp/cmake/ModbusTools/bin/Win64-Server",
5454
"cacheVariables": {
@@ -59,9 +59,9 @@
5959
{
6060
"name": "Win32-MSVC",
6161
"displayName": "Win32 Config Default MSVC",
62-
"description": "Using compilers for Visual Studio 17 2022 (x64_x86 architecture)",
62+
"description": "Using compilers for Visual Studio 18 2026 (x64_x86 architecture)",
6363
"inherits": "Win-Base",
64-
"generator": "Visual Studio 17 2022",
64+
"generator": "Visual Studio 18 2026",
6565
"toolset": "host=x64",
6666
"architecture": "win32",
6767
"binaryDir": "$env{USERPROFILE}/tmp/cmake/ModbusTools/bin/Win32",

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Supported Modbus functions:
3131
ModbusTools work with Qt Framework version 5 (5.8 or later).
3232
It based on `ModbusLib` cross platform library project:
3333

34-
https://github.com/serhmarch/ModbusLib
34+
<https://github.com/serhmarch/ModbusLib>
3535

3636
### Memory item addressing
3737

@@ -116,6 +116,8 @@ __*New in version 0.5*__:
116116
`SendMessage` window contains list with predefined functions
117117
with parameters that can be periodically sent to the server.
118118

119+
To loop single message or message list checkup `Loop` checkbox.
120+
119121
### Send Bytes window (v0.5+)
120122

121123
This is a new tool for Modbus client that provides abillity to send
@@ -133,6 +135,8 @@ can be seen in LogView as regular Modbus message as well.
133135
`SendBytes` window contains list with predefined byte sequences
134136
that can be periodically sent to the server.
135137

138+
To loop single message or message list checkup `Loop` checkbox.
139+
136140
### Scanner window (v0.3+)
137141

138142
`Scanner` tool window is intended to scan Modbus network to determine which device
@@ -239,8 +243,7 @@ To view all documentation and possible uses of objects and methods, use the buil
239243
### Server Simulation window
240244

241245
The server has the ability to simulate/change data (actions, automaticaly change values)
242-
with predefined simulation action types (`Simulation` tab near `LogView`,
243-
menu `View->Simulation` window and menu `Simulation`):
246+
with predefined simulation action types (menu `Simulation->Simulation` or `Window->Simulation`):
244247
* `Increment` - changing value by adding or subtracting (if incrementValue < 0) incrementValue
245248
* `Sine` - sine function with parameters of period, shift, amplitude
246249
* `Random` - randomly changing values with specified range

build.bat

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
::cmake --preset "Win32-MSVC"
2-
::cmake --build --preset "Win32-MSVC-Release"
3-
41
cmake --preset "Win64-MSVC"
52
cmake --build --preset "Win64-MSVC-Release"

doc/CMakeLists.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,24 @@ if(MBTOOLS_DOXYGEN_EXECUTABLE)
1515
message(STATUS "MBTOOLS-DOC: Found Doxygen: ${MBTOOLS_DOXYGEN_EXECUTABLE}")
1616
project("mbtools-doc" VERSION ${MBTOOLS_VERSION})
1717

18+
find_program(MBTOOLS_DOT_EXECUTABLE
19+
NAMES dot dot.exe
20+
PATHS
21+
"$ENV{ProgramFiles}\\Graphviz\\bin"
22+
"$ENV{ProgramFiles\(x86\)}\\Graphviz\\bin"
23+
DOC "Graphviz dot executable"
24+
)
25+
26+
if(MBTOOLS_DOT_EXECUTABLE)
27+
get_filename_component(MBTOOLS_DOC_DOT_PATH "${MBTOOLS_DOT_EXECUTABLE}" DIRECTORY)
28+
set(MBTOOLS_DOC_HAVE_DOT YES)
29+
message(STATUS "MBTOOLS-DOC: Found Graphviz dot: ${MBTOOLS_DOT_EXECUTABLE}")
30+
else()
31+
set(MBTOOLS_DOC_DOT_PATH "")
32+
set(MBTOOLS_DOC_HAVE_DOT NO)
33+
message(WARNING "MBTOOLS-DOC: Graphviz dot not found. Class/collaboration graphs will be disabled in generated docs.")
34+
endif()
35+
1836
set(MBTOOLS_DOC_SRC_DIR "${CMAKE_CURRENT_LIST_DIR}")
1937
set(MBTOOLS_DOC_DIR "${CMAKE_BINARY_DIR}/doc")
2038

doc/DoxyfileServer.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2542,7 +2542,7 @@ HIDE_UNDOC_RELATIONS = YES
25422542
# set to NO
25432543
# The default value is: NO.
25442544

2545-
HAVE_DOT = YES
2545+
HAVE_DOT = ${MBTOOLS_DOC_HAVE_DOT}
25462546

25472547
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
25482548
# to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2785,7 +2785,7 @@ INTERACTIVE_SVG = NO
27852785
# found. If left blank, it is assumed the dot tool can be found in the path.
27862786
# This tag requires that the tag HAVE_DOT is set to YES.
27872787

2788-
DOT_PATH =
2788+
DOT_PATH = "${MBTOOLS_DOC_DOT_PATH}"
27892789

27902790
# The DOTFILE_DIRS tag can be used to specify one or more directories that
27912791
# contain dot files that are included in the documentation (see the \dotfile
-434 Bytes
Loading
-9.25 KB
Loading
46.5 KB
Loading
56.9 KB
Loading
60.5 KB
Loading

0 commit comments

Comments
 (0)