Skip to content

Commit

Permalink
chore: reduce compilation warnings
Browse files Browse the repository at this point in the history
解决部分文档编译警告

解决cpp文件中部分注释编译警告

Issue: linuxdeepin/dtk#96
  • Loading branch information
OneZeroer committed Jul 12, 2023
1 parent ac719a9 commit 903e021
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 11 deletions.
4 changes: 3 additions & 1 deletion docs/widgets/dalertcontrol.zh_CN.dox
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@

@fn void Dtk::Widget::DAlertControl::showAlertMessage(const QString &text, QWidget *follower, int duration = 3000)
@brief 显示警告消息
@param[in] follow 指定文本消息跟随的对象
@param[in] text 警告的文本
@param[in] follower 指定文本消息跟随的对象
@param[in] duration 显示的时间长度, 单位毫秒
@sa DAlertControl::showAlertMessage(const QString &text, int duration = 3000)

@fn void Dtk::Widget::DAlertControl::hideAlertMessage()
Expand Down
7 changes: 4 additions & 3 deletions docs/widgets/dtabbar.zh_CN.dox
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
@brief 标签拖放.
@param[in] index 拖放的标签索引
@param[in] action 拖放的动作
@param[in] target 被拖拽的 DTabBar 实例

@fn void DTabBar::dragStarted()
@brief 开始拖起.
Expand Down Expand Up @@ -132,17 +133,17 @@
@param[in] index 标签索引
@param[in] enable 是否启用.

@fn void DTabBar::setTabEnabled(int index, bool enable)
@fn QString DTabBar::tabText(int index) const
@brief 返回标签索引位置文本.
@param index 标签索引.
@param[in] index 标签索引.
@return 返回对应索引的文本.

@fn void DTabBar::setTabText(int index, const QString &text)
@brief 设置标签索引位置文本.
@param[in] index 标签索引
@param[in] text 标签文本.

@fn void DTabBar::setTabText(int index, const QString &text)
@fn QIcon DTabBar::tabIcon(int index) const
@brief 返回标签索引位置图标.
@param[in] index 标签索引.
@return 对应标签的图标.
Expand Down
8 changes: 4 additions & 4 deletions src/util/daccessibilitychecker.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -442,9 +442,9 @@ void DAccessibilityChecker::setOutputFormat(DAccessibilityChecker::OutputFormat
\brief 日志格式枚举.
\value AssertFormat
\var AssertFormat
断言日志,如检查到缺失,直接断言。
\value FullFormat
\var FullFormat
全日志,全日志将所有的缺失信息显示到控制台中。
\sa DAccessibilityChecker::outputFormat
*/
Expand All @@ -455,9 +455,9 @@ void DAccessibilityChecker::setOutputFormat(DAccessibilityChecker::OutputFormat
\brief 检测的角色.
检测角色目前分为两种。
\value Widget
\var Widget
所有继承自 QWidget 的小控件
\value ViewItem
\var ViewItem
所有继承自 QStandardItem 的View Item项
*/

Expand Down
2 changes: 1 addition & 1 deletion src/widgets/dmainwindow.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,7 @@ void DMainWindow::setEnableSystemMove(bool enableSystemMove)

/*!
\brief DMainWindow::setEnableBlurWindow 设置窗口模糊效果
\~shinese 开启此功能请设置setAttribute(Qt::WA_TranslucentBackground)
\~chinese 开启此功能请设置setAttribute(Qt::WA_TranslucentBackground)
\a enableBlurWindow true开启模糊效果 false关闭模糊效果
*/
void DMainWindow::setEnableBlurWindow(bool enableBlurWindow)
Expand Down
4 changes: 2 additions & 2 deletions src/widgets/dprintpreviewdialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2434,7 +2434,7 @@ void DPrintPreviewDialogPrivate::pageRangeError(TipsNum tipNum)
信号,但每次接收的数据量较小,因此不用担心响应速度的问题。
默认情况下的打印预览窗口为同步模式。
\section1 \b 基本使用
\section \b 基本使用
该代码在 example 中可以看到,这里简单贴出对应内容.
\snippet mainwindow.cpp 0
Expand All @@ -2450,7 +2450,7 @@ void DPrintPreviewDialogPrivate::pageRangeError(TipsNum tipNum)
根据用户选择的页码多少,向外获取对应页码的原始数据。
\warning pageRange 对应的数据为页码值,而非页面索引值!
\section1 \b 其他接口
\section \b 其他接口
除同步和异步接口之外,打印预览还提供给外部一些其他接口,例如
setDocName 设置数据文件名,在输出 pdf 或者图片时可以看到
效果。 setPrintFromPath 按照文件路径打印的接口,使用这个
Expand Down

0 comments on commit 903e021

Please sign in to comment.