Parcourir la source

Add class list documentation for core module

Patrick-Christopher Mattulat il y a 6 mois
Parent
commit
ccafd33df8
27 fichiers modifiés avec 135 ajouts et 27 suppressions
  1. 5 1
      include/ls-std/core/Class.hpp
  2. 5 1
      include/ls-std/core/ConditionalFunctionExecutor.hpp
  3. 5 1
      include/ls-std/core/LibraryVersion.hpp
  4. 5 1
      include/ls-std/core/Version.hpp
  5. 5 1
      include/ls-std/core/evaluator/EmptyStringArgumentEvaluator.hpp
  6. 5 1
      include/ls-std/core/evaluator/IndexOutOfBoundsEvaluator.hpp
  7. 5 1
      include/ls-std/core/evaluator/NullPointerArgumentEvaluator.hpp
  8. 5 1
      include/ls-std/core/evaluator/NullPointerEvaluator.hpp
  9. 5 1
      include/ls-std/core/evaluator/RawNullPointerArgumentEvaluator.hpp
  10. 5 1
      include/ls-std/core/evaluator/RawNullPointerEvaluator.hpp
  11. 5 1
      include/ls-std/core/exception/EventNotHandledException.hpp
  12. 5 1
      include/ls-std/core/exception/EventNotSubscribedException.hpp
  13. 5 1
      include/ls-std/core/exception/Exception.hpp
  14. 5 1
      include/ls-std/core/exception/ExceptionMessage.hpp
  15. 5 1
      include/ls-std/core/exception/FileNotFoundException.hpp
  16. 5 1
      include/ls-std/core/exception/FileOperationException.hpp
  17. 5 1
      include/ls-std/core/exception/IllegalArgumentException.hpp
  18. 5 1
      include/ls-std/core/exception/IllegalArithmeticOperationException.hpp
  19. 5 1
      include/ls-std/core/exception/IncompleteJsonException.hpp
  20. 5 1
      include/ls-std/core/exception/IndexOutOfBoundsException.hpp
  21. 5 1
      include/ls-std/core/exception/NotImplementedException.hpp
  22. 5 1
      include/ls-std/core/exception/NullPointerException.hpp
  23. 5 1
      include/ls-std/core/jni/JniApi.hpp
  24. 5 1
      include/ls-std/core/jni/JniClass.hpp
  25. 5 1
      include/ls-std/core/jni/JniClassParameter.hpp
  26. 5 1
      include/ls-std/core/jni/JniMethod.hpp
  27. 5 1
      include/ls-std/core/jni/JniReturnValue.hpp

+ 5 - 1
include/ls-std/core/Class.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-07
- * Changed:         2023-05-15
+ * Changed:         2024-05-24
  *
  * */
 
@@ -13,6 +13,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'Class', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL Class

+ 5 - 1
include/ls-std/core/ConditionalFunctionExecutor.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-13
-* Changed:         2023-02-21
+* Changed:         2024-05-24
 *
 * */
 
@@ -13,6 +13,10 @@
 #include <functional>
 #include <ls-std/os/dynamic-goal.hpp>
 
+/*
+ * @class(name: 'ConditionalFunctionExecutor', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL ConditionalFunctionExecutor

+ 5 - 1
include/ls-std/core/LibraryVersion.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-05-02
- * Changed:         2023-02-06
+ * Changed:         2024-05-24
  *
  * */
 
@@ -13,6 +13,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'LibraryVersion', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL LibraryVersion

+ 5 - 1
include/ls-std/core/Version.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-09-27
- * Changed:         2023-05-16
+ * Changed:         2024-05-24
  *
  * */
 
@@ -16,6 +16,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string_view>
 
+/*
+ * @class(name: 'Version', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL Version : public ls::std::core::interface_type::ISerializable

+ 5 - 1
include/ls-std/core/evaluator/EmptyStringArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-08
-* Changed:         2023-02-22
+* Changed:         2024-05-24
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'EmptyStringArgumentEvaluator', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL EmptyStringArgumentEvaluator : public ls::std::core::interface_type::IEvaluator

+ 5 - 1
include/ls-std/core/evaluator/IndexOutOfBoundsEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2023-02-22
+* Changed:         2024-05-24
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'IndexOutOfBoundsEvaluator', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL IndexOutOfBoundsEvaluator : public ls::std::core::interface_type::IEvaluator

+ 5 - 1
include/ls-std/core/evaluator/NullPointerArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-08
-* Changed:         2023-05-23
+* Changed:         2024-05-24
 *
 * */
 
@@ -16,6 +16,10 @@
 #include <memory>
 #include <string>
 
+/*
+ * @class(name: 'NullPointerArgumentEvaluator', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL NullPointerArgumentEvaluator : public ls::std::core::interface_type::IEvaluator

+ 5 - 1
include/ls-std/core/evaluator/NullPointerEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-08
-* Changed:         2023-05-24
+* Changed:         2024-05-24
 *
 * */
 
@@ -15,6 +15,10 @@
 #include <memory>
 #include <string>
 
+/*
+ * @class(name: 'NullPointerEvaluator', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL NullPointerEvaluator : public ls::std::core::interface_type::IEvaluator

+ 5 - 1
include/ls-std/core/evaluator/RawNullPointerArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-05-23
-* Changed:         2023-05-24
+* Changed:         2024-05-24
 *
 * */
 
@@ -15,6 +15,10 @@
 #include <ls-std/core/type/RawPointer.hpp>
 #include <string>
 
+/*
+ * @class(name: 'RawNullPointerArgumentEvaluator', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   template<typename T>

+ 5 - 1
include/ls-std/core/evaluator/RawNullPointerEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-05-24
-* Changed:         2023-05-24
+* Changed:         2024-05-24
 *
 * */
 
@@ -15,6 +15,10 @@
 #include <ls-std/core/type/RawPointer.hpp>
 #include <string>
 
+/*
+ * @class(name: 'RawNullPointerEvaluator', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   template<typename T>

+ 5 - 1
include/ls-std/core/exception/EventNotHandledException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-05-27
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'EventNotHandledException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL EventNotHandledException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/EventNotSubscribedException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-05-27
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'EventNotSubscribedException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL EventNotSubscribedException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/Exception.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-22
-* Changed:         2023-05-19
+* Changed:         2024-05-24
 *
 * */
 
@@ -15,6 +15,10 @@
 #include <string>
 #include <string_view>
 
+/*
+ * @class(name: 'Exception', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL Exception : public ::std::exception

+ 5 - 1
include/ls-std/core/exception/ExceptionMessage.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-07
-* Changed:         2023-02-07
+* Changed:         2024-05-24
 *
 * */
 
@@ -13,6 +13,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'ExceptionMessage', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL ExceptionMessage

+ 5 - 1
include/ls-std/core/exception/FileNotFoundException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-17
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'FileNotFoundException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL FileNotFoundException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/FileOperationException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-15
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'FileOperationException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL FileOperationException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/IllegalArgumentException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-09
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'IllegalArgumentException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL IllegalArgumentException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/IllegalArithmeticOperationException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-07
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'IllegalArithmeticOperationException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL IllegalArithmeticOperationException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/IncompleteJsonException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-04-30
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'IncompleteJsonException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL IncompleteJsonException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/IndexOutOfBoundsException.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2023-05-19
+* Changed:         2024-05-24
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'IndexOutOfBoundsException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL IndexOutOfBoundsException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/NotImplementedException.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-27
-* Changed:         2023-05-19
+* Changed:         2024-05-24
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'NotImplementedException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL NotImplementedException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/exception/NullPointerException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-06
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @class(name: 'NullPointerException', package: 'Core')
+ * */
+
 namespace ls::std::core
 {
   class LS_STD_DYNAMIC_GOAL NullPointerException : public ls::std::core::Exception

+ 5 - 1
include/ls-std/core/jni/JniApi.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-07
-* Changed:         2023-04-11
+* Changed:         2024-05-24
 *
 * */
 
@@ -13,6 +13,10 @@
 #include <ls-std/core/interface/IJniApi.hpp>
 #include <ls-std/os/dynamic-goal.hpp>
 
+/*
+ * @class(name: 'JniApi', package: 'Core')
+ * */
+
 namespace ls::std::core::experimental
 {
   class LS_STD_DYNAMIC_GOAL JniApi : public ls::std::core::experimental::interface_type::IJniApi

+ 5 - 1
include/ls-std/core/jni/JniClass.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-07
-* Changed:         2023-05-16
+* Changed:         2024-05-24
 *
 * */
 
@@ -20,6 +20,10 @@
 #include <string>
 #include <unordered_map>
 
+/*
+ * @class(name: 'JniClass', package: 'Core')
+ * */
+
 namespace ls::std::core::experimental
 {
   class LS_STD_DYNAMIC_GOAL JniClass

+ 5 - 1
include/ls-std/core/jni/JniClassParameter.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-07
-* Changed:         2023-05-16
+* Changed:         2024-05-24
 *
 * */
 
@@ -16,6 +16,10 @@
 #include <memory>
 #include <string>
 
+/*
+ * @class(name: 'JniClassParameter', package: 'Core')
+ * */
+
 namespace ls::std::core::experimental
 {
   class LS_STD_DYNAMIC_GOAL JniClassParameter

+ 5 - 1
include/ls-std/core/jni/JniMethod.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-08
-* Changed:         2023-05-16
+* Changed:         2024-05-24
 *
 * */
 
@@ -15,6 +15,10 @@
 #include <string>
 #include <string_view>
 
+/*
+ * @class(name: 'JniMethod', package: 'Core')
+ * */
+
 namespace ls::std::core::experimental
 {
   class LS_STD_DYNAMIC_GOAL JniMethod

+ 5 - 1
include/ls-std/core/jni/JniReturnValue.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-08
-* Changed:         2023-04-11
+* Changed:         2024-05-24
 *
 * */
 
@@ -13,6 +13,10 @@
 #include <jni.h>
 #include <ls-std/os/dynamic-goal.hpp>
 
+/*
+ * @class(name: 'JniReturnValue', package: 'Core')
+ * */
+
 namespace ls::std::core::experimental
 {
   class LS_STD_DYNAMIC_GOAL JniReturnValue