Skip to content

Commit 00b6b33

Browse files
committed
Modify documents
1 parent c73e200 commit 00b6b33

5 files changed

Lines changed: 20 additions & 17 deletions

File tree

.github/workflows/build.yml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -190,14 +190,16 @@ jobs:
190190
echo "" >> ${{github.workspace}}/Release.md
191191
fi
192192
193-
content=$(<${{github.workspace}}/ChangeLog_zh_CN.md)
194-
if [[ $content =~ ${{env.RabbitRemoteControl_VERSION}} ]]; then
195-
echo "## :cn: 修改日志" >> ${{github.workspace}}/Release.md
196-
echo "" >> ${{github.workspace}}/Release.md
197-
get_section ${{github.workspace}}/ChangeLog_zh_CN.md >> ${{github.workspace}}/Release.md
198-
echo "" >> ${{github.workspace}}/Release.md
199-
fi
193+
# content=$(<${{github.workspace}}/ChangeLog_zh_CN.md)
194+
# if [[ $content =~ ${{env.RabbitRemoteControl_VERSION}} ]]; then
195+
# echo "## :cn: 修改日志" >> ${{github.workspace}}/Release.md
196+
# echo "" >> ${{github.workspace}}/Release.md
197+
# get_section ${{github.workspace}}/ChangeLog_zh_CN.md >> ${{github.workspace}}/Release.md
198+
# echo "" >> ${{github.workspace}}/Release.md
199+
# fi
200200
fi
201+
202+
echo "-------------------------" >> ${{github.workspace}}/Release.md
201203
# 因为其它网站也可能需要,所以用完整的 URL
202204
echo "|:us: English|:cn: 中文|" >> ${{github.workspace}}/Release.md
203205
echo "| :- |:- |" >> ${{github.workspace}}/Release.md
@@ -225,6 +227,7 @@ jobs:
225227
echo "" >> ${{github.workspace}}/Release.md
226228
fi
227229
fi
230+
echo "-------------------------" >> ${{github.workspace}}/Release.md
228231
echo "" >> ${{github.workspace}}/Release.md
229232
echo "Commit: [${{github.sha}}](https://github.com/KangLin/RabbitRemoteControl/commit/${{github.sha}})" >> ${{github.workspace}}/Release.md
230233
echo "" >> ${{github.workspace}}/Release.md

Plugins/Player/PluginPlayer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class CPluginPlayer : public CPlugin
1919
#endif
2020
// [Qt plugin interface]
2121

22-
// CPluginClient interface
22+
// CPlugin interface
2323
public:
2424
virtual const TYPE Type() const override;
2525
virtual const QString Protocol() const override;

Src/OperateDesktop.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class CBackendThread;
4444
* It starts a background thread by default.
4545
* It implements a background thread to handle a operate.
4646
* Can be used with plugins whose plugin interface
47-
* derives from CPluginClient for operate is blocking model.
47+
* derives from CPlugin for operate is blocking model.
4848
*
4949
* Principle: Start a background thread (CBackendThread) in Start() .
5050
* Call InstanceBackend() in the thread to instantiate CBackend,

docs/Doxygen/Chinese.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
6767
+ 线程模型:
6868
- 阻塞:大多数控制协议实现库连接都是阻塞的。所以需要一个线程处理一个连接。
69-
\see CPluginClient COperateThread
69+
\see CPlugin COperateThread
7070
- 非阻塞:例如Qt事件。一个线程可以处理多个连接。
7171
- 插件没有后台线程,所有连接使用主线程
7272
- 插件有一个后台线程,所有连接使用同一个后台线程
@@ -78,9 +78,9 @@
7878
+ 写一个插件:
7979
- 生成插件目标名称格式为: PluginClient${PROJECT_NAME}
8080
\include Plugins/FreeRDP/Client/CMakeLists.txt
81-
- 实现插件接口 CPluginClient
81+
- 实现插件接口 CPlugin
8282
+ 如果没有后台线程,或者是阻塞线程模型(一个后台线程处理一个连接。连接是阻塞的)。例如:FreeRDP
83-
- 从 CPluginClient 派生插件。例如: \ref CPluginFreeRDP
83+
- 从 CPlugin 派生插件。例如: \ref CPluginFreeRDP
8484
+ 在类声明中实现Qt接口:
8585
\snippet Plugins/FreeRDP/Client/PluginFreeRDP.h Qt plugin interface
8686
+ 在构造函数中初始化操作。例如:初始化资源等
@@ -125,7 +125,7 @@
125125
+ 工作线程模型
126126
- 阻塞:大多数控制协议实现库连接都是阻塞的。所以需要一个线程处理一个连接。
127127
每个连接者启动一个后台线程。
128-
\see CPluginClient COperateThread
128+
\see CPlugin COperateThread
129129
- 非阻塞:例如Qt事件。一个线程可以处理多个连接。
130130
插件启动一个线程,连接者重用此线程,它不再启动线程。
131131
\see CPluginClientThread COperateDesktop

docs/Doxygen/English.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
\details
7171
+ Thread module
7272
- Blocked: Most control protocol implementation library connections are blocking.
73-
\see CPluginClient COperateThread
73+
\see CPlugin COperateThread
7474
- No-blocking: eg: qt event. A thread can handle multiple connections.
7575
- The plugin does not have a background thread, and all connections use the main thread
7676
- The plugin has a background thread, and all connections use the same background thread
@@ -82,11 +82,11 @@
8282
+ Write a plugin:
8383
- The format of the generated plug-in target name is: PluginClient${PROJECT_NAME}
8484
\include Plugins/FreeRDP/Client/CMakeLists.txt
85-
- Implement CPluginClient.
85+
- Implement CPlugin.
8686
+ No background thread or Blocked background thread
8787
(A background thread handles a connection. The connection is blocked.).
8888
E.g. FreeRDP
89-
- Derive from CPluginClient. For example: CPluginFreeRDP
89+
- Derive from CPlugin. For example: CPluginFreeRDP
9090
+ Implement the Qt interface in the class declaration:
9191
\snippet Plugins/FreeRDP/Client/PluginFreeRDP.h Qt plugin interface
9292
+ Initialize the operation in the constructor.
@@ -135,7 +135,7 @@
135135
- CConnect
136136
+ The module of work thread
137137
- Blocked: Most control protocol implementation library connections are blocking.
138-
\see CPluginClient COperateThread
138+
\see CPlugin COperateThread
139139
- No-blocking: eg: qt event. A thread can handle multiple connections.
140140
\see CPluginClientThread COperateDesktop
141141
+ Class relationship

0 commit comments

Comments
 (0)