Skip to content

Commit 59a0fa5

Browse files
serhmarchserhmarch
committed
Update docs
1 parent 72485f0 commit 59a0fa5

21 files changed

+158
-79
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ doc/output/client
66
doc/output/server
77
TODO
88

9+
#ignore only cmake user presets in root folder
10+
/CMakeUserPresets.json
11+
912
# Python Byte-compiled / optimized / DLL files
1013
__pycache__/
1114
*.py[cod]

‎CMakeLists.txt‎

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -33,59 +33,59 @@ add_subdirectory(src/client)
3333
add_subdirectory(src/server)
3434

3535
# Check if Doxygen is available
36-
find_package(Doxygen)
37-
38-
if (DOXYGEN_FOUND)
39-
message("Doxygen found: ${DOXYGEN_EXECUTABLE}")
40-
# Add a target to generate Doxygen documentation for the client
41-
add_custom_target(DoxygenClient
42-
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/DoxyfileClient
43-
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
44-
COMMENT "Generating Doxygen documentation for Client"
45-
VERBATIM
46-
)
47-
48-
# Add a target to generate Doxygen documentation for the server
49-
add_custom_target(DoxygenServer
50-
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/DoxyfileServer
51-
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
52-
COMMENT "Generating Doxygen documentation for Server"
53-
VERBATIM
54-
)
55-
56-
# Find qhelpgenerator executable
57-
find_program(QHELPGENERATOR_EXECUTABLE qhelpgenerator)
58-
59-
if (QHELPGENERATOR_EXECUTABLE)
60-
message("qhelpgenerator found: ${QHELPGENERATOR_EXECUTABLE}")
61-
62-
# Add a target to generate Qt help files for the server
63-
add_custom_target(QtHelpServer
64-
COMMAND ${QHELPGENERATOR_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/output/ModbusServer.qhcp
65-
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc/output
66-
COMMENT "Generating Qt help files for Server"
67-
VERBATIM
68-
)
69-
70-
# Add a target to generate Qt help files for the client
71-
add_custom_target(QtHelpClient
72-
COMMAND ${QHELPGENERATOR_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/output/ModbusClient.qhcp
73-
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc/output
74-
COMMENT "Generating Qt help files for Client"
75-
VERBATIM
76-
)
77-
78-
# Make sure QtHelpServer runs after DoxygenServer
79-
add_dependencies(QtHelpServer DoxygenServer)
80-
81-
# Make sure QtHelpClient runs after DoxygenClient
82-
add_dependencies(QtHelpClient DoxygenClient)
83-
else()
84-
message(STATUS "qhelpgenerator not found. Qt help targets will not be generated.")
85-
endif()
86-
else()
87-
message(STATUS "Doxygen not found. Documentation targets will not be generated/regenerated.")
88-
endif()
36+
#find_package(Doxygen)
37+
#
38+
#if (DOXYGEN_FOUND)
39+
# message("Doxygen found: ${DOXYGEN_EXECUTABLE}")
40+
# # Add a target to generate Doxygen documentation for the client
41+
# add_custom_target(DoxygenClient
42+
# COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/DoxyfileClient
43+
# WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
44+
# COMMENT "Generating Doxygen documentation for Client"
45+
# VERBATIM
46+
# )
47+
#
48+
# # Add a target to generate Doxygen documentation for the server
49+
# add_custom_target(DoxygenServer
50+
# COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/DoxyfileServer
51+
# WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
52+
# COMMENT "Generating Doxygen documentation for Server"
53+
# VERBATIM
54+
# )
55+
#
56+
# # Find qhelpgenerator executable
57+
# find_program(QHELPGENERATOR_EXECUTABLE qhelpgenerator)
58+
#
59+
# if (QHELPGENERATOR_EXECUTABLE)
60+
# message("qhelpgenerator found: ${QHELPGENERATOR_EXECUTABLE}")
61+
#
62+
# # Add a target to generate Qt help files for the server
63+
# add_custom_target(QtHelpServer
64+
# COMMAND ${QHELPGENERATOR_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/output/ModbusServer.qhcp
65+
# WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc/output
66+
# COMMENT "Generating Qt help files for Server"
67+
# VERBATIM
68+
# )
69+
#
70+
# # Add a target to generate Qt help files for the client
71+
# add_custom_target(QtHelpClient
72+
# COMMAND ${QHELPGENERATOR_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/output/ModbusClient.qhcp
73+
# WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc/output
74+
# COMMENT "Generating Qt help files for Client"
75+
# VERBATIM
76+
# )
77+
#
78+
# # Make sure QtHelpServer runs after DoxygenServer
79+
# add_dependencies(QtHelpServer DoxygenServer)
80+
#
81+
# # Make sure QtHelpClient runs after DoxygenClient
82+
# add_dependencies(QtHelpClient DoxygenClient)
83+
# else()
84+
# message(STATUS "qhelpgenerator not found. Qt help targets will not be generated.")
85+
# endif()
86+
#else()
87+
# message(STATUS "Doxygen not found. Documentation targets will not be generated/regenerated.")
88+
#endif()
8989

9090
install(TARGETS ${MB_LIBRARY_NAME} DESTINATION .)
9191
install(TARGETS ${MBTOOLS_CORE_LIB_NAME} DESTINATION .)

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,9 @@ and for registers memory (`mem3x`, `mem4x`) it work with `uint16` values:
195195
if mem4x[0] > 32768:
196196
mem4x[0] = 0
197197
```
198+
__*New in version 0.4.3*__:
199+
> Starting with this version, the server supports script modules -
200+
the ability to include Python modules in a single `*pjs` project file.
198201

199202
To view all documentation and possible uses of objects and methods, use the built-in help system.
200203

‎build.bat‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@ cmake --build --preset "Win32-MSVC-Release"
33

44
cmake --preset "Win64-MSVC"
55
cmake --build --preset "Win64-MSVC-Release"
6-

‎doc/DoxyfileClient‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = ModbusClient
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 0.4.2
51+
PROJECT_NUMBER = 0.4.3
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

‎doc/DoxyfileServer‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = ModbusServer
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 0.4.2
51+
PROJECT_NUMBER = 0.4.3
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

‎doc/images/server_port_dialog.png‎

-635 Bytes
Loading

‎doc/images/server_port_dialogx.png‎

2.18 KB
Loading

‎doc/images/server_scriptmodule_dialog.png‎

5.15 KB
Loading

‎doc/images/server_scriptmodule_window.png‎

10.6 KB
Loading

0 commit comments

Comments
 (0)