Skip to content

Commit 662f379

Browse files
KangLinKangLin
committed
Plugin: Modify documents
1 parent a9de7cf commit 662f379

5 files changed

Lines changed: 88 additions & 34 deletions

File tree

‎Src/BackendServer.h‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@
44
#include "Backend.h"
55

66
class COperateServer;
7+
8+
/*!
9+
* \~chinese
10+
* \brief 服务接口。它由协议插件实现。
11+
*
12+
* \~english
13+
* \brief Server interface. It is implemented by the Protocol plugin.
14+
*
15+
* \~
16+
* \see COperateServer CFrmViewServer
17+
* \ingroup gOperateServer
18+
*/
719
class PLUGIN_EXPORT CBackendServer : public CBackend
820
{
921
Q_OBJECT
@@ -12,10 +24,25 @@ class PLUGIN_EXPORT CBackendServer : public CBackend
1224
virtual ~CBackendServer();
1325

1426
public Q_SLOTS:
27+
/*!
28+
* \brief Disconnect client
29+
* \param szIp
30+
* \param port
31+
*/
1532
virtual void slotDisconnect(const QString& szIp, const quint16 port) = 0;
1633

1734
Q_SIGNALS:
35+
/*!
36+
* \brief emit when new client connected
37+
* \param szIp
38+
* \param port
39+
*/
1840
void sigConnected(const QString& szIp, const quint16 port);
41+
/*!
42+
* \brief emit when the client disconnected
43+
* \param szIp
44+
* \param port
45+
*/
1946
void sigDisconnected(const QString& szIp, const quint16 port);
2047

2148
private:

‎Src/FrmViewServer.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515
/*!
1616
* \brief The CFrmViewServer class
17-
* \see COperateServer
17+
* \see COperateServer CBackendServer
18+
* \ingroup gOperateServer
1819
*/
1920
class PLUGIN_EXPORT CFrmViewServer : public QWidget
2021
{

‎Src/OperateServer.h‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ class CBackend;
99
class CBackendThread;
1010
class CFrmViewServer;
1111

12+
/*!
13+
* \~chinese
14+
* \defgroup gOperateServer 服务类
15+
* \~english
16+
* \defgroup gOperateServer Server class
17+
* \~
18+
* \ingroup PLUGIN_API
19+
*/
20+
1221
/*!
1322
* \~chinese 服务操作接口
1423
* \note 此接口仅由插件实现。 \n
@@ -23,7 +32,8 @@ class CFrmViewServer;
2332
* The connection object runs in a background thread.
2433
*
2534
* \~
26-
* \see CFrmViewServer
35+
* \see CFrmViewServer CBackendServer
36+
* \ingroup gOperateServer
2737
*/
2838
class PLUGIN_EXPORT COperateServer : public COperate
2939
{

‎docs/Compile/Windows.md‎

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,15 @@ Prior versions don't have CMake support.
6363
- Doxygen: [http://www.doxygen.nl/](http://www.doxygen.nl/)
6464
- Nsis: [https://nsis.sourceforge.io/Download](https://nsis.sourceforge.io/Download)
6565
- vcpkg: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)
66+
- Bash shell:
67+
- [MSys2](https://www.msys2.org/)
68+
- [Cygwin](https://cygwin.com/)
69+
70+
Msys2 or Cygwin uses the default installation.
71+
You can open the "Operate → terminal" with [this program](https://github.com/KangLin/RabbitRemoteControl/releases),
72+
and it will automatically appear in 'Settings → Properties → Shell Name'.
73+
If it is not the default installation location,
74+
please check 'Help' and set it according to the methods there.
6675

6776
### Compilation
6877

@@ -117,7 +126,7 @@ See: [Compile integration](../../.github/workflows/msvc.yml)
117126

118127
- Use vcpkg
119128
+ Source-code location: https://github.com/microsoft/vcpkg/
120-
129+
121130
git clone https://github.com/microsoft/vcpkg.git
122131
cd vcpkg
123132
bootstrap-vcpkg.bat
@@ -129,7 +138,7 @@ See: [Compile integration](../../.github/workflows/msvc.yml)
129138
- Compile from source code
130139
+ Source-code location: https://github.com/FreeRDP/FreeRDP
131140
+ Compilation instructions: https://github.com/FreeRDP/FreeRDP/wiki/Compilation
132-
141+
133142
git clone https://github.com/FreeRDP/FreeRDP.git
134143
cd FreeRDP
135144
mkdir build
@@ -150,7 +159,7 @@ See: [Compile integration](../../.github/workflows/msvc.yml)
150159
- Compile from source code
151160
+ Source-code location: [https://github.com/LibVNC/libvncserver](https://github.com/LibVNC/libvncserver)
152161
It is recommended to use the patches from: https://github.com/KangLin/libvncserver
153-
162+
154163
cd vcpkg
155164
vcpkg install zlib openssl libjpeg-turbo
156165
git clone https://github.com/KangLin/libvncserver.git
@@ -163,7 +172,7 @@ See: [Compile integration](../../.github/workflows/msvc.yml)
163172
the CMake parameter needs to be specified to compile this project:
164173

165174
-DLibVNCServer_DIR=[LibVNCServer installation path]/lib/cmake/LibVNCServer
166-
175+
167176
#### RabbitVNC
168177

169178
- Compile from source code
@@ -176,7 +185,7 @@ See: [Compile integration](../../.github/workflows/msvc.yml)
176185
mkdir build
177186
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%CD%/install -DCMAKE_TOOLCHAIN_FILE=[vcpkg 安装目录]/scripts/buildsystems/vcpkg.cmake
178187
cmake --build . --config Release --target install
179-
188+
180189
- When RabbitVNC is compiled from source,
181190
the CMake parameter needs to be specified to compile this project:
182191

@@ -208,7 +217,7 @@ Source-code location: https://github.com/KangLin/tigervnc
208217

209218
- Use vcpkg
210219
+ Source-code location: https://github.com/microsoft/vcpkg/
211-
220+
212221
cd vcpkg
213222
vcpkg install libdatachannel
214223

@@ -217,7 +226,7 @@ Source-code location: https://github.com/KangLin/tigervnc
217226
- Compile from source code
218227
+ Source-code location: [https://github.com/paullouisageneau/libdatachannel](https://github.com/paullouisageneau/libdatachannel)
219228
+ Compilation instructions: [https://github.com/paullouisageneau/libdatachannel/blob/master/BUILDING.md](https://github.com/paullouisageneau/libdatachannel/blob/master/BUILDING.md)
220-
229+
221230
git clone https://github.com/paullouisageneau/libdatachannel.git
222231
cd libdatachannel
223232
git submodule update --init --recursive
@@ -235,7 +244,7 @@ Source-code location: https://github.com/KangLin/tigervnc
235244

236245
- Compile from source code
237246
+ Source-code location: [https://github.com/qxmpp-project/qxmpp](https://github.com/qxmpp-project/qxmpp)
238-
247+
239248
git clone https://github.com/qxmpp-project/qxmpp.git
240249
cd qxmpp
241250
mkdir build
@@ -247,7 +256,7 @@ Source-code location: https://github.com/KangLin/tigervnc
247256
the CMake parameter needs to be specified to compile this project:
248257

249258
-DQXmpp_DIR=[QXmpp installation path]/lib/cmake/qxmpp
250-
259+
251260
#### QTermWidget (Not currently supported on Windows)
252261
- Compile from source code
253262
+ Source-code location: [https://github.com/lxqt/qtermwidget](https://github.com/lxqt/qtermwidget)
@@ -263,12 +272,12 @@ Source-code location: https://github.com/KangLin/tigervnc
263272
)
264273

265274
Reference: [msvc.yml](../../.github/workflows/msvc.yml)
266-
275+
267276
#### libssh
268277

269278
- Use vcpkg
270279
+ Source-code location: https://github.com/microsoft/vcpkg/
271-
280+
272281
cd vcpkg
273282
vcpkg install libssh
274283

@@ -284,14 +293,14 @@ Source-code location: https://github.com/KangLin/tigervnc
284293

285294
- Compile from source code
286295
+ Source-code location: https://github.com/KangLin/qt-solutions/
287-
296+
288297
git clone https://github.com/KangLin/qt-solutions.git
289298
cd qt-solutions
290299
mkdir build
291300
cd build
292301
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%CD%/install
293302
cmake --build . --config Release --target install
294-
303+
295304
- When QtService is compiled from source,
296305
the CMake parameter needs to be specified to compile this project:
297306

‎docs/Compile/Windows_zh_CN.md‎

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
cmake -DQT_ROOT=[Qt 安装位置] -DQt6_DIR=[Qt 安装位置] ......
5151
#当使用 Qt5 时
5252
cmake -DQT_ROOT=[Qt 安装位置] -DQt5_DIR=[Qt 安装位置] ......
53-
53+
5454
- IDE：Qt Creator。建议使用 v5.0.2 及以后版本，以前版本对 CMake 支持不够。
5555
当前使用版本：18.0.0
5656
- Git: [https://www.git-scm.com/](https://www.git-scm.com/)
@@ -60,6 +60,13 @@
6060
- Doxygen: [http://www.doxygen.nl/](http://www.doxygen.nl/)
6161
- Nsis: [https://nsis.sourceforge.io/Download](https://nsis.sourceforge.io/Download)
6262
- vcpkg: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)
63+
- Bash shell:
64+
- [MSys2](https://www.msys2.org/)
65+
- [Cygwin](https://cygwin.com/)
66+
67+
Msys2 或者 Cygwin 使用默认安装，可用[本程序](https://github.com/KangLin/RabbitRemoteControl/releases)
68+
打开“操作 → 终端”，在“设置 → 属性 → Shell 名称”中会自动出现。
69+
如果不是默认安装位置，请查看“帮助”并按其中方法设置。
6370

6471
### 编译
6572

@@ -114,7 +121,7 @@
114121

115122
- 使用 vcpkg
116123
+ 源码位置: https://github.com/microsoft/vcpkg/
117-
124+
118125
git clone https://github.com/microsoft/vcpkg.git
119126
cd vcpkg
120127
bootstrap-vcpkg.bat
@@ -131,7 +138,7 @@
131138
mkdir build
132139
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%CD%/install -DWITH_SERVER=ON
133140
cmake --build . --config Release --target install
134-
141+
135142
- 当 FreeRDP 从源码编译时，编译本项需要指定的 CMake 参数：
136143
- -DBUILD_FREERDP=ON
137144
- -DWinPR_DIR=[freerdp 安装目录]/lib/cmake/WinPR3
@@ -145,19 +152,19 @@
145152
- 从源码编译
146153
+ 源码位置：[https://github.com/LibVNC/libvncserver](https://github.com/LibVNC/libvncserver)
147154
建议使用补丁: https://github.com/KangLin/libvncserver
148-
155+
149156
cd vcpkg
150157
vcpkg install zlib openssl libjpeg-turbo
151158
git clone https://github.com/KangLin/libvncserver.git
152159
cd libvncserver
153160
mkdir build
154161
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%CD%/install -DCMAKE_TOOLCHAIN_FILE=[vcpkg 安装目录]/scripts/buildsystems/vcpkg.cmake
155162
cmake --build . --config Release --target install
156-
163+
157164
- 当 LibVNCServer 从源码编译时，编译本项需要指定的 CMake 参数：
158165

159166
-DLibVNCServer_DIR=[LibVNCServer 安装目录]/lib/cmake/LibVNCServer
160-
167+
161168
#### RabbitVNC
162169

163170
- 从源码编译
@@ -189,23 +196,23 @@
189196
mkdir build
190197
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%CD%/install -DCMAKE_TOOLCHAIN_FILE=[vcpkg 安装目录]/scripts/buildsystems/vcpkg.cmake
191198
cmake --build . --config Release --target install
192-
199+
193200
- 当 TigerVNC 从源码编译时，编译本项需要指定的 CMake 参数：
194201

195202
-Dtigervnc_DIR=[TigerVNC 安装目录]/lib/cmake/tigervnc
196-
203+
197204
#### libdatachannel
198205

199206
- 使用 vcpkg
200207
+ 源码位置: https://github.com/microsoft/vcpkg/
201-
208+
202209
cd vcpkg
203210
vcpkg install libdatachannel
204211

205212
- 从源码编译
206213
+ 源码位置： [https://github.com/paullouisageneau/libdatachannel](https://github.com/paullouisageneau/libdatachannel)
207214
+ 编译详见： [https://github.com/paullouisageneau/libdatachannel/blob/master/BUILDING.md](https://github.com/paullouisageneau/libdatachannel/blob/master/BUILDING.md)
208-
215+
209216
git clone https://github.com/paullouisageneau/libdatachannel.git
210217
cd libdatachannel
211218
git submodule update --init --recursive
@@ -223,7 +230,7 @@
223230

224231
- 从源码编译
225232
+ 源码位置： [https://github.com/qxmpp-project/qxmpp](https://github.com/qxmpp-project/qxmpp)
226-
233+
227234
git clone https://github.com/qxmpp-project/qxmpp.git
228235
cd qxmpp
229236
mkdir build
@@ -234,7 +241,7 @@
234241
- 当 QXmpp 从源码编译时，编译本项需要指定的 CMake 参数：
235242

236243
-DQXmpp_DIR=[QXmpp 安装目录]/lib/cmake/qxmpp
237-
244+
238245
#### QTermWidget (暂不支持 Windows）
239246

240247
- 从源码编译
@@ -252,7 +259,7 @@
252259
参考： [msvc.yml](../../.github/workflows/msvc.yml)
253260

254261
#### QtWebEngine
255-
262+
256263
默认情况下，包括 Webm(开源),不包括 x264、x265(版权原因)
257264
- 检查支持
258265
在你的 QtWebEngine 程序中访问 chrome://media-internals 或 chrome://gpu 可以看到当前支持的解码格式。
@@ -271,12 +278,12 @@
271278
./configure -webengine-proprietary-codecs
272279
make
273280
make install
274-
281+
275282
#### libssh
276283

277284
- 使用 vcpkg
278285
+ 源码位置: https://github.com/microsoft/vcpkg/
279-
286+
280287
cd vcpkg
281288
vcpkg install libssh
282289

@@ -290,14 +297,14 @@
290297

291298
- 从源码编译
292299
+ 源码位置：: https://github.com/KangLin/qt-solutions/
293-
300+
294301
git clone https://github.com/KangLin/qt-solutions.git
295302
cd qt-solutions
296303
mkdir build
297304
cd build
298305
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=%CD%/install
299306
cmake --build . --config Release --target install
300-
307+
301308
- 当 QtService 从源码编译时，编译本项需要指定的 CMake 参数：
302309

303310
-DQtService_DIR=[QtService 安装目录]/lib/cmake/QtService
@@ -306,7 +313,7 @@
306313

307314
- 从源码编译
308315
+ 源码位置： https://github.com/seladb/PcapPlusPlus
309-
316+
310317
git clone https://github.com/seladb/PcapPlusPlus.git
311318

312319
+ 从 [npcap](https://npcap.com) 下载 `npcap SDK`
@@ -388,7 +395,7 @@ Windows10 及以后的版本需要 [npcap](https://npcap.com)
388395
参见： https://learn.microsoft.com/vcpkg/users/buildsystems/cmake-integration#settings-reference
389396
- 编译
390397
+ 命令行编译
391-
398+
392399
cd RabbitRemoteControl
393400
mkdir build
394401
cmake .. -DCMAKE_BUILD_TYPE=Release ^

0 commit comments

Comments
 (0)