Document: Modify doxygen

Author: KangLin

App/Client/Favorite/FavoriteDatabase.h

@@ -9,7 +9,7 @@
 
 /*!
  * \brief The CFavoriteDatabase class
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class CFavoriteDatabase : public CDatabaseTree
 {

App/Client/Recent/RecentDatabase.h

@@ -10,7 +10,7 @@
 
 /*!
  * \brief The CRecentDatabase class
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class CRecentDatabase : public CDatabase
 {

Plugins/WebBrowser/Bookmark/BookmarkDatabase.h

@@ -61,7 +61,7 @@ struct BookmarkItem {
 
 /*!
  * \brief The CBookmarkDatabase class
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class CBookmarkDatabase : public CDatabase
 {

Plugins/WebBrowser/History/HistoryDatabase.h

@@ -19,7 +19,7 @@ struct HistoryItem {
 
 /*!
  * \brief The CHistoryDatabase class
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class CHistoryDatabase : public CDatabase
 {

Src/Database/Database.h

@@ -11,12 +11,11 @@
 class CParameterDatabase;
 
 /*!
- * \chinese 提供打开数据库和初始化数据库等接口
- * \english Provide interfaces such as opening the database and initializing the database
+ * \~chinese 提供打开数据库和初始化数据库等接口
+ * \~english Provide interfaces such as opening the database and initializing the database
  *
  * \~
- * \ingroup APP_API PLUGIN_API
- * \defgroup DATABASE_API
+ * \ingroup APP_API PLUGIN_API LIBAPI_DATABASE
  */
 class PLUGIN_EXPORT CDatabase : public QObject
 {
@@ -26,6 +25,10 @@ class PLUGIN_EXPORT CDatabase : public QObject
     explicit CDatabase(QObject *parent = nullptr);
     virtual ~CDatabase();
 
+    //!@{
+    //! \~chinese \name 共享已打开的数据库
+    //! \~english \name Share an existing database
+
     /*!
      * \brief Share an existing database
      * \param db
@@ -37,10 +40,15 @@ class PLUGIN_EXPORT CDatabase : public QObject
      * \param pPara
      */
     [[nodiscard]] bool SetDatabase(const QSqlDatabase db, const CParameterDatabase* pPara);
+    //!@}
+
     [[nodiscard]] QSqlDatabase GetDatabase() const;
 
-    /*!
-     * \brief Open a new database
+    //!@{
+    //! \~chinese \name 打开一个新的数据库
+    //! \~english \name Open a new database
+
+    /*! \brief Open a new database
      * \param pPara: nullptr, use sqlite database
      * \param szConnectName: connect name
      * \return
@@ -62,7 +70,8 @@ class PLUGIN_EXPORT CDatabase : public QObject
     [[nodiscard]] bool OpenSQLiteDatabase(
         const QString& szFile,
         const QString& szConnectionName = QString());
-
+    //!@}
+    
     [[nodiscard]] virtual bool IsOpen() const;
     /*!
      * \brief Close database
@@ -72,21 +81,30 @@ class PLUGIN_EXPORT CDatabase : public QObject
 
     [[nodiscard]] const CParameterDatabase* GetParameter() const;
     [[nodiscard]] const QString GetError() const;
-    
+
+    //!@{
+    //! \~chinese \name 导入与导出操作
+    //! \~english \name Export and import operate
     [[nodiscard]] virtual bool ExportToJsonFile(const QString& szFile);
     [[nodiscard]] virtual bool ImportFromJsonFile(const QString& szFile);
+    //!@}
 
 Q_SIGNALS:
     void sigChanged();
 
 protected:
+    //!@{
+    //! \~chinese \name 初始化数据库和表
+    //! \~english \name Initialize table
     /*!
      * \brief Initialize database
      * \return
      */
     [[nodiscard]] virtual bool OnInitializeDatabase();
     [[nodiscard]] virtual bool OnInitializeSqliteDatabase();
     [[nodiscard]] virtual bool OnInitializeMySqlDatabase();
+    //!@}
+
     void SetError(const QString& szErr = QString());
 
     [[nodiscard]] virtual bool ExportToJson(QJsonObject& obj);
@@ -105,7 +123,7 @@ class PLUGIN_EXPORT CDatabase : public QObject
 
 /*!
  * \brief Icon database
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class PLUGIN_EXPORT CDatabaseIcon : public CDatabase
 {
@@ -140,7 +158,7 @@ class PLUGIN_EXPORT CDatabaseIcon : public CDatabase
 /*!
  * \brief File database
  * \note The file field is filename, don't include path.
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class PLUGIN_EXPORT CDatabaseFile : public CDatabase
 {

Src/Database/DatabaseFilter.h

@@ -6,7 +6,7 @@
 
 /*!
  * \brief The CDatabaseFilter class
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class PLUGIN_EXPORT CDatabaseFilter : public CDatabase
 {

Src/Database/DatabaseTree.h

@@ -55,7 +55,7 @@ class PLUGIN_EXPORT TreeItem {
 
 /*!
  * \brief The CDatabaseNode class
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class PLUGIN_EXPORT CDatabaseNode : public CDatabase
 {
@@ -104,7 +104,7 @@ class PLUGIN_EXPORT CDatabaseNode : public CDatabase
 
 /*!
  * \brief The CDatabaseTree class
- * \ingroup DATABASE_API
+ * \ingroup LIBAPI_DATABASE
  */
 class PLUGIN_EXPORT CDatabaseTree : public CDatabase
 {

Src/Parameter.h

@@ -25,7 +25,12 @@
  *      \ref section_Use_CParameterPlugin
  *      \see CParameterPlugin
  *           COperate::SetGlobalParameters
- *   3. 同时在应用程序、插件管理者 (CManager) 和插件内有效。暂时没有使用此类型。
+ *   3. 同时在应用程序、插件管理者 (CManager) 和插件内有效。
+ *     - 可以在插件管理者 (CManager) 和插件中以及应用中使用。
+ *     - 应用程序可以通过 CManager::GetGlobalParameters() 得到它。
+ *     - 插件可以通 CParameterPlugin::GetGlobalParameters() 访问。
+ *     - 应用通过  CManager::GetSettingsWidgets() 进行设置。
+ *     \see CParameterGlobal CParameterPlugin CManager CManager::GetGlobalParameters
  * - 参数界面： CParameterUI
  *
  * \~english
@@ -49,7 +54,11 @@
  *      \see CParameterClient
  *           COperate::SetGlobalParameters
  *   3. Valid in both the application and the Client and the plugin.
- *      This type is not used at this time.
+ *     - The parameters is valid in the CManager, plugin and application
+ *     - The applicat can be accessed via CManager::GetGlobalParameters()
+ *     - The plugin can be accessed via CParameterPlugin::GetGlobalParameters()
+ *     - The application can be set it via CManager::GetSettingsWidgets()
+ *     \see CParameterGlobal CParameterPlugin CManager CManager::GetGlobalParameters
  * - CParameterUI
  * \~
  * \ingroup LIBAPI_PLUGIN

docs/Doxygen/Chinese.h

@@ -146,4 +146,8 @@
 + 类关系图
   \image html docs/Image/Channel.svg
 
+\defgroup LIBAPI_DATABASE 数据库
+\ingroup LIBAPI
+\brief 数据库
+
 */

docs/Doxygen/English.h

@@ -153,5 +153,10 @@
 \details
 + Class relationship
   \image html docs/Image/Channel.svg
-  
+
+
+\defgroup LIBAPI_DATABASE Database
+\ingroup LIBAPI
+\brief Database
+
 */