Plugin: Modify documents

Author: KangLin

Src/BackendServer.h

@@ -4,6 +4,18 @@
 #include "Backend.h"
 
 class COperateServer;
+
+/*!
+ * \~chinese
+ * \brief 服务接口。它由协议插件实现。
+ *
+ * \~english
+ * \brief Server interface. It is implemented by the Protocol plugin.
+ *
+ * \~
+ * \see COperateServer CFrmViewServer
+ * \ingroup gOperateServer
+ */
 class PLUGIN_EXPORT CBackendServer : public CBackend
 {
     Q_OBJECT
@@ -12,10 +24,25 @@ class PLUGIN_EXPORT CBackendServer : public CBackend
     virtual ~CBackendServer();
 
 public Q_SLOTS:
+    /*!
+     * \brief Disconnect client
+     * \param szIp
+     * \param port
+     */
     virtual void slotDisconnect(const QString& szIp, const quint16 port) = 0;
 
 Q_SIGNALS:
+    /*!
+     * \brief emit when new client connected
+     * \param szIp
+     * \param port
+     */
     void sigConnected(const QString& szIp, const quint16 port);
+    /*!
+     * \brief emit when the client disconnected
+     * \param szIp
+     * \param port
+     */
     void sigDisconnected(const QString& szIp, const quint16 port);
 
 private:

Src/FrmViewServer.h

@@ -14,7 +14,8 @@
 
 /*!
  * \brief The CFrmViewServer class
- * \see COperateServer
+ * \see COperateServer CBackendServer
+ * \ingroup gOperateServer
  */
 class PLUGIN_EXPORT CFrmViewServer : public QWidget
 {

Src/OperateServer.h

@@ -9,6 +9,15 @@ class CBackend;
 class CBackendThread;
 class CFrmViewServer;
 
+/*!
+ * \~chinese
+ * \defgroup gOperateServer 服务类
+ * \~english
+ * \defgroup gOperateServer Server class
+ * \~
+ * \ingroup PLUGIN_API
+ */
+
 /*!
  * \~chinese 服务操作接口
  * \note 此接口仅由插件实现。 \n
@@ -23,7 +32,8 @@ class CFrmViewServer;
  *            The connection object runs in a background thread.
  *
  * \~
- * \see CFrmViewServer
+ * \see CFrmViewServer CBackendServer
+ * \ingroup gOperateServer
  */
 class PLUGIN_EXPORT COperateServer : public COperate
 {

docs/Compile/Windows.md

@@ -63,7 +63,16 @@ Prior versions don't have CMake support.
 - Doxygen: [http://www.doxygen.nl/](http://www.doxygen.nl/)
 - Nsis: [https://nsis.sourceforge.io/Download](https://nsis.sourceforge.io/Download)
 - vcpkg: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)
-
+- Bash shell:
+  - [MSys2](https://www.msys2.org/)
+  - [Cygwin](https://cygwin.com/)
+
+  Msys2 or Cygwin uses the default installation.
+  You can open the terminal with [this program](https://github.com/KangLin/RabbitRemoteControl/releases),
+  and it will automatically appear in 'Settings → Properties → Shell Name'.
+  If it is not the default installation location,
+  please check 'Help' and set it according to the methods there.
+  
 ### Compilation
 
 See: [Compile integration](../../.github/workflows/msvc.yml)

docs/Compile/Windows_zh_CN.md

@@ -60,6 +60,13 @@
 - Doxygen: [http://www.doxygen.nl/](http://www.doxygen.nl/)
 - Nsis: [https://nsis.sourceforge.io/Download](https://nsis.sourceforge.io/Download)
 - vcpkg: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)
+- Bash shell:
+  - [MSys2](https://www.msys2.org/)
+  - [Cygwin](https://cygwin.com/)
+
+  Msys2 或者 Cygwin 使用默认安装，可用[本程序](https://github.com/KangLin/RabbitRemoteControl/releases)
+  打开终端，在“设置 → 属性 → Shell 名称”中会自动出现。
+  如果不是默认安装位置，请查看“帮助”并按其中方法设置。
 
 ### 编译