From 772ca04bde7f548b5b9becc98be730e60a7c609b Mon Sep 17 00:00:00 2001
From: LyYeeeYuwu <1066454892@qq.com>
Date: Fri, 14 Jul 2023 10:40:24 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20update=20docs=20for=20dfontcombobox=20?=
 =?UTF-8?q?=E6=9B=B4=E6=96=B0dfontcombobox=E7=9A=84=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Log: update docs

Issue: https://github.com/linuxdeepin/dtk/issues/94
---
 docs/widgets/dfontcombobox.zh_CN.dox | 44 +++++++++++++++++++++---
 src/widgets/dfontcombobox.cpp        | 51 +++++++++++++++++-----------
 2 files changed, 72 insertions(+), 23 deletions(-)

diff --git a/docs/widgets/dfontcombobox.zh_CN.dox b/docs/widgets/dfontcombobox.zh_CN.dox
index dc1bd2c7a..a03573283 100644
--- a/docs/widgets/dfontcombobox.zh_CN.dox
+++ b/docs/widgets/dfontcombobox.zh_CN.dox
@@ -2,11 +2,47 @@
 @~chinese
 @file dfontcombobox.h
 @ingroup button
-@class
-@brief
-@details
+@class Dtk::Widget::DFontComboBox
+@brief 继承自 DComboBox类 字体选择下拉列表
+@details DFontComboBox类 继承自 DComboBox类 提供了进行系统字体选择的下拉列表
 
-TODO: 添加类简介、示例代码、示例截图和函数使用说明等
+@image html DFontComboBox.png
 
+@fn DFontComboBox::DFontComboBox(QWidget *parent)
+@brief DFontComboBox 构造函数
+@param[in] parent 父构件对象
+
+@fn void DFontComboBox::setWritingSystem(QFontDatabase::WritingSystem script)
+@brief 与 QFontComboBox::setWritingSystem 功能相同, 设置字体选择器所使用的书写系统
+@param[in] script QFontDatabase::WritingSystem 类对象, Qt支持的书写系统
+
+@fn QFontDatabase::WritingSystem DFontComboBox::writingSystem() const
+@brief 与 QFontComboBox::writingSystem 功能相同, 返回字体选择器所使用的书写系统
+@return 字体选择器所选用的书写系统
+
+@fn void DFontComboBox::setFontFilters(QFontComboBox::FontFilters filters)
+@brief 与 QFontComboBox::setFontFilters 功能相同, 设置字体选择器可以显示的字体
+@param[in] script QFontComboBox::FontFilters 类对象, Qt支持的字体类型
+
+@fn QFontComboBox::FontFilters DFontComboBox::fontFilters() const
+@brief 与 QFontComboBox::fontFilters 功能相同, 返回字体选择器可以显示的字体
+@return 字体选择器所选用的字体
+
+@fn QFont DFontComboBox::currentFont() const
+@brief 与 QFontComboBox::currentFont 功能相同, 返回当前选择字体
+@return 当前选择字体
+
+@fn QSize DFontComboBox::sizeHint() const
+@brief 与 QFontComboBox::sizeHint 功能相同, 返回字体选择器的推荐大小
+@return 推荐大小
+
+@fn void DFontComboBox::setCurrentFont(const QFont &f)
+@brief 与 QFontComboBox::setCurrentFont 功能相同, 设置当前选择字体
+@param[in] QFont类型, 要选择的字体
+
+@fn bool DFontComboBox::event(QEvent *e)
+@brief 与 QFontComboBox::event 功能相同, 返回 DComboBox::event(e)的布尔值
+@return DComboBox::event(e)
 
 */
+
diff --git a/src/widgets/dfontcombobox.cpp b/src/widgets/dfontcombobox.cpp
index 132fc03a0..012e674c7 100644
--- a/src/widgets/dfontcombobox.cpp
+++ b/src/widgets/dfontcombobox.cpp
@@ -30,7 +30,7 @@ class DFontComboBoxPrivate : public DComboBoxPrivate
 
     virtual ~DFontComboBoxPrivate() override;
 
-    // DFontComboBox的具体实现采用QFontComboBox的实现
+    // The specific implementation of DFontComboBox adopts the implementation of QFontComboBox
     QFontComboBox* impl;
 };
 
@@ -40,17 +40,22 @@ DFontComboBoxPrivate::~DFontComboBoxPrivate()
 }
 
 /*!
- * \~chinese \class DFontComboBox
- * \~chinese \brief DFontComboBox 字体选择下拉列表
- * \~chinese \li DFontComboBox 提供了系统字体选择功能
- *
- * \~chinese \note\row 代码示例
- * \~chinese \note\row DFontComboBox *fontComboBox = new DFontComboBox();
- */
-
+@~english
+  @class DFontComboBox
+  @brief The DFontComboBox class provides combobox for selecting font
+
+  The DFontComboBox class provides functions to select system font
+
+  @code 
+  #code example
+  DFontComboBox *fontComboBox = new DFontComboBox();
+  @endcode
+  
+  @image html DFontComboBox.png
 /*!
- * \chinese \brief DFontComboBox 构造函数
- * \chinese \param parent参数被发送到 DComboBox 构造函数
+@~english
+  @brief DFontComboBox constructor.
+  @param[in] parent is passed to DComboBox constructor
  */
 DFontComboBox::DFontComboBox(QWidget *parent)
     : DComboBox(*new DFontComboBoxPrivate(this), parent)
@@ -69,7 +74,8 @@ DFontComboBox::~DFontComboBox()
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::setWritingSystem相同
+@~english
+  @brief same as QFontComboBox::setWritingSystem
  */
 void DFontComboBox::setWritingSystem(QFontDatabase::WritingSystem script)
 {
@@ -78,7 +84,8 @@ void DFontComboBox::setWritingSystem(QFontDatabase::WritingSystem script)
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::writingSystem相同
+@~english
+  @brief same as QFontComboBox::writingSystem
  */
 QFontDatabase::WritingSystem DFontComboBox::writingSystem() const
 {
@@ -87,7 +94,8 @@ QFontDatabase::WritingSystem DFontComboBox::writingSystem() const
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::setFontFilters相同
+@~english
+  @brief same as QFontComboBox::setFontFilters
  */
 void DFontComboBox::setFontFilters(QFontComboBox::FontFilters filters)
 {
@@ -96,7 +104,8 @@ void DFontComboBox::setFontFilters(QFontComboBox::FontFilters filters)
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::fontFilters相同
+@~english
+  @brief same as QFontComboBox::fontFilters
  */
 QFontComboBox::FontFilters DFontComboBox::fontFilters() const
 {
@@ -105,7 +114,8 @@ QFontComboBox::FontFilters DFontComboBox::fontFilters() const
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::currentFont相同
+@~english
+  @brief same as QFontComboBox::currentFont
  */
 QFont DFontComboBox::currentFont() const
 {
@@ -114,7 +124,8 @@ QFont DFontComboBox::currentFont() const
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::sizeHint相同
+@~english
+  @brief same as QFontComboBox::sizeHint
  */
 QSize DFontComboBox::sizeHint() const
 {
@@ -123,7 +134,8 @@ QSize DFontComboBox::sizeHint() const
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::setCurrentFont相同
+@~english
+  @brief same as QFontComboBox::setCurrentFont
  */
 void DFontComboBox::setCurrentFont(const QFont &f)
 {
@@ -132,7 +144,8 @@ void DFontComboBox::setCurrentFont(const QFont &f)
 }
 
 /*!
- * \~chinese \brief 与QFontComboBox::event相同
+@~english
+  @brief same as QFontComboBox::event
  */
 bool DFontComboBox::event(QEvent *e)
 {