From e79c74d2e90a30ba1cf6b6d8d9e46f9c5c46dffc Mon Sep 17 00:00:00 2001 From: chengyulong Date: Fri, 12 Mar 2021 11:18:53 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0DGuiApplicationHelper?= =?UTF-8?q?::setSingleInstanceInterval=E8=AF=A6=E7=BB=86=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 添加DGuiApplicationHelper::setSingleInstanceInterval更详细的注释,增加对成员变量waitTime默认值和相关成员函数setSingleInstance的使用 Log: 添加注释 Change-Id: Ie0aeed59e3c41c9e06c131f1e1724473d10d42de --- src/kernel/dguiapplicationhelper.cpp | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/kernel/dguiapplicationhelper.cpp b/src/kernel/dguiapplicationhelper.cpp index b23bf0ca..b727b789 100644 --- a/src/kernel/dguiapplicationhelper.cpp +++ b/src/kernel/dguiapplicationhelper.cpp @@ -890,6 +890,14 @@ DGuiApplicationHelper::ColorType DGuiApplicationHelper::paletteType() const return d->paletteType; } +/*! + * \~chinese \brief DGuiApplicationHelper::setSingleInstance 设置DGuiApplicationHelper实例 + * \~chinese \param key 实例关键字 + * \~chinese \param singleScope 实例使用范围 + * \~chinese \return 设置是否成功 + * \~chinese \note 此处所用到DGuiApplicationHelperPrivate::waitTime默认值为3000ms，可通过 + * \~chinese \note DGuiApplicationHelper::setSingleInstanceInterval设置 + */ bool DGuiApplicationHelper::setSingleInstance(const QString &key, DGuiApplicationHelper::SingleScope singleScope) { bool new_server = !_d_singleServer.exists(); @@ -979,8 +987,10 @@ bool DGuiApplicationHelper::setSingleInstance(const QString &key, DGuiApplicatio return true; } + /*! - * \~chinese \brief DGuiApplicationHelper::setSingelInstanceInterval设置从QLocalServer获取消息的等待时间 + * \~chinese \brief DGuiApplicationHelper::setSingelInstanceInterval设置从QLocalServer获取消息的等待时间， + * \~chinese \brief 用于在重新创建DGuiApplicationHelper单例时，检测DGuiApplicationHelper单例是否存在且有响应 * \~chinese \param interval等待时间，如 interval 为 -1 则没有超时一直等待，默认和 QLocalSocket 一致 3000ms * \~chinese \note 需要在 DGuiApplicationHelper::setSingleInstance 之前调用否则无效。 */