chore: update comments and apiDoc

Former-commit-id: ce2f082
Nambers · Jan 21, 2023 · e79857c · e79857c
1 parent c975924
commit e79857c
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -140,10 +140,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ```
 
 # 依赖
-| Dependence name                            | Url                                 | Author             | License                              |
-|--------------------------------------------|-------------------------------------|--------------------|--------------------------------------|
-| JSON for modern C++                        | <https://github.com/nlohmann/json>  | Niels Lohmann      | MIT                                  |
-| UTF8-CPP: UTF-8 with C++ in a Portable Way | <https://github.com/nemtrif/utfcpp> | Nemanja Trifunovic | BSL-1.0                              |
-| JNI Headers                                | Null                                | Java               | GNU General Public License version 2 |
+| Dependence name                                                                 | Url                                        | Author             | License                              |
+|---------------------------------------------------------------------------------|--------------------------------------------|--------------------|--------------------------------------|
+| JSON for modern C++                                                             | <https://github.com/nlohmann/json>         | Niels Lohmann      | MIT                                  |
+| UTF8-CPP: UTF-8 with C++ in a Portable Way                                      | <https://github.com/nemtrif/utfcpp>        | Nemanja Trifunovic | BSL-1.0                              |
+| JNI Headers                                                                     | Null                                       | Java               | GNU General Public License version 2 |
+| BS::thread_pool: a fast, lightweight, and easy-to-use C++17 thread pool library | <https://github.com/bshoshany/thread-pool> | Barak Shoshany     | MIT                                  |
 # Stargazers
 [![Stargazers repo roster for @Nambers/MiraiCP](https://reporoster.com/stars/Nambers/MiraiCP)](https://github.com/Nambers/MiraiCP/stargazers)
diff --git a/cpp/Doxyfile b/cpp/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = MiraiCP
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v2.13.0-alpha-3
+PROJECT_NUMBER         = v2.13.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -871,9 +871,10 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src/include \
-                         src/examples \
-                         src/common
+INPUT                  = include \
+                         examples \
+                         common \
+                         src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -919,7 +920,8 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = include/libloader/BS_thread_pool.hpp \
+                         src/single_include
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

diff --git a/cpp/include/libloader/BS_thread_pool.hpp b/cpp/include/libloader/BS_thread_pool.hpp
@@ -1,3 +1,24 @@
+// Copyright (c) 2023. Eritque arcus and contributors.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or any later version(in your opinion).
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+/**
+ *  Modified version of Barak Shoshany's thread pool library
+ *  link: https://github.com/bshoshany/thread-pool
+ *  License: MIT
+ */
 #pragma once
 
 /**
@@ -556,8 +577,7 @@ namespace BS {
             threadIndexCounter = index;
             LibLoader::logger.warning("resetting thread in pool at index " + std::to_string(index)+" due to a user caused error");
             new (&threads[index]) std::thread(&thread_pool::worker, this);
-            while (threadIndexCounter != index + 1)
-                ;
+            while (threadIndexCounter != index + 1);
             threadIndexCounter = oldThCounter;
         }
 

diff --git a/cpp/src/libloader/Plugin.cpp b/cpp/src/libloader/Plugin.cpp
@@ -1,4 +1,4 @@
-// Copyright (c) 2022 - 2022. Antares, Eritque arcus and contributors.
+// Copyright (c) 2022 - 2023. Antares, Eritque arcus and contributors.
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU Affero General Public License as
@@ -14,7 +14,7 @@
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
-/// 本文件的目的是分离出PluginListManager交互的部分函数实现，方便代码的阅读和维护
+// 本文件的目的是分离出PluginListManager交互的部分函数实现，方便代码的阅读和维护
 #include "MiraiCPMacros.h"
 // -----------------------
 #include "BS_thread_pool.hpp"

diff --git a/cpp/src/libloader/ktInterface.cpp b/cpp/src/libloader/ktInterface.cpp
@@ -1,4 +1,4 @@
-// Copyright (c) 2022 - 2022. Antares, Eritque arcus and contributors.
+// Copyright (c) 2022 - 2023. Antares, Eritque arcus and contributors.
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU Affero General Public License as
@@ -14,7 +14,7 @@
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //
 
-/// 本文件的全部函数实现都是kt线程调用的函数
+// 本文件的全部函数实现都是kt线程调用的函数
 
 #include "MiraiCPMacros.h"
 // -----------------------

diff --git a/kotlin/shared/src/commonMain/kotlin/BuiltInConstants.kt b/kotlin/shared/src/commonMain/kotlin/BuiltInConstants.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 - 2022. Eritque arcus and contributors.
+ * Copyright (c) 2020 - 2023. Eritque arcus and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -19,7 +19,7 @@
 package tech.eritquearcus.miraicp.shared
 
 object BuiltInConstants {
-    const val date = "Thu Nov 10 10:46:28 EST 2022"
-    const val version = "2.13.0-alpha"
-    const val miraiVersion = "2.13.0-RC2"
+    const val date = "Sat Jan 21 13:42:53 EST 2023"
+    const val version = "2.13.1"
+    const val miraiVersion = "2.14.0-RC"
 }