diff --git a/docs/images/DFrame.png b/docs/images/DFrame.png new file mode 100644 index 000000000..bbfa98da5 Binary files /dev/null and b/docs/images/DFrame.png differ diff --git a/docs/widgets/dframe.zh_CN.dox b/docs/widgets/dframe.zh_CN.dox index 1c75cf4bc..1f4da010d 100644 --- a/docs/widgets/dframe.zh_CN.dox +++ b/docs/widgets/dframe.zh_CN.dox @@ -2,11 +2,37 @@ @~chinese @file dframe.h @ingroup layout -@class +@class Dtk::Widget::DFrame @brief @details -TODO: 添加类简介、示例代码、示例截图和函数使用说明等 +@image html ../images/DFrame.png +@fn DFrame::DFrame(QWidget *parent) +@brief 用于其他需要边框的widget的基类 +@param[in] parent + +@fn void DFrame::setFrameRounded(bool on) +@brief 设置边框圆角是否开启 +@param[in] on true开启,false关闭 + +@fn void DFrame::setBackgroundRole(DGUI_NAMESPACE::DPalette::ColorType type) +@brief 设置边框背景画刷的角色类型 +@param[in] type 背景画刷的角色类型 + +@fn void DFrame::paintEvent(QPaintEvent *event) + +*/ + +/*! +@~chinese +@file dframe.h +@ingroup layout +@class DFramePrivate +@brief +@details + +@fn DFramePrivate::DFramePrivate(DFrame *qq) */ + diff --git a/src/widgets/dframe.cpp b/src/widgets/dframe.cpp index 76acf0e32..97b51adc6 100644 --- a/src/widgets/dframe.cpp +++ b/src/widgets/dframe.cpp @@ -23,8 +23,9 @@ DFramePrivate::DFramePrivate(DFrame *qq) } /*! - \brief DFrame::DFrame 用于其他需要边框的widget的基类 - \a parent +@~english + @brief DFrame::DFrame is used for other widget base class that require frame + @param[in] parent */ DFrame::DFrame(QWidget *parent) : DFrame(*new DFramePrivate(this), parent) @@ -33,8 +34,9 @@ DFrame::DFrame(QWidget *parent) } /*! - \brief DFrame::setFrameRounded设置边框圆角是否开启 - \a on true开启 false关闭 +@~english + @brief DFrame::setFrameRounded sets whether the frame corners are rounded + @param[in] on true means rounded, while false means not */ void DFrame::setFrameRounded(bool on) { @@ -48,8 +50,9 @@ void DFrame::setFrameRounded(bool on) } /*! - \brief DFrame::setBackgroundRole 设置边框背景画刷的角色类型 - \a type 背景画刷的角色类型 +@~english + @brief DFrame::setBackgroundRole sets role type of the frame background brush + @param[in] type role type of the frame background brush */ void DFrame::setBackgroundRole(DGUI_NAMESPACE::DPalette::ColorType type) {