Add class documentation for core module

doc/coline.html

@@ -187,6 +187,56 @@ li.class_li
 <li class="class_li"><a class="default_link_layout" href="#time_windowsclock">WindowsClock</a></li>
 </ul>
 <h2>Classes</h2>
+<h3 id="core_class">core.Class</h3>
+<p class="default_text">This class represents a base class offering minimal reflection on the class name.</p>
+<h3 id="core_libraryversion">core.LibraryVersion</h3>
+<p class="default_text">This class provides the version information of this library.</p>
+<h3 id="core_version">core.Version</h3>
+<p class="default_text">This class represents a semantic versioning scheme.</p>
+<h3 id="core_conditionalfunctionexecutor">core.ConditionalFunctionExecutor</h3>
+<p class="default_text">This class can execute any method matching a specific signature based on a specific condition.</p>
+<h3 id="core_nullpointerargumentevaluator">core.NullPointerArgumentEvaluator</h3>
+<p class="default_text">This class evaluates whether a passed shared pointer argument is null.</p>
+<h3 id="core_nullpointerevaluator">core.NullPointerEvaluator</h3>
+<p class="default_text">This class evaluates whether a passed shared pointer reference is null.</p>
+<h3 id="core_rawnullpointerargumentevaluator">core.RawNullPointerArgumentEvaluator</h3>
+<p class="default_text">This class evaluates whether a passed raw pointer argument is null.</p>
+<h3 id="core_indexoutofboundsevaluator">core.IndexOutOfBoundsEvaluator</h3>
+<p class="default_text">This class evaluates whether a passed index is out of bounds.</p>
+<h3 id="core_emptystringargumentevaluator">core.EmptyStringArgumentEvaluator</h3>
+<p class="default_text">This class evaluates whether a passed string is empty.</p>
+<h3 id="core_rawnullpointerevaluator">core.RawNullPointerEvaluator</h3>
+<p class="default_text">This class evaluates whether a passed raw pointer reference is null.</p>
+<h3 id="core_jnireturnvalue">core.JniReturnValue</h3>
+<p class="default_text">This class represents a method return value of a Java class within Java Native Interface (JNI) context.</p>
+<h3 id="core_jniclassparameter">core.JniClassParameter</h3>
+<p class="default_text">This class holds important information for the usage of the Java Native Interface (JNI), like Java environment or a specific Java object.</p>
+<h3 id="core_jniapi">core.JniApi</h3>
+<p class="default_text">This class represents an API for the Java Native Interface (JNI) wrapping basic JNI end points.</p>
+<h3 id="core_jnimethod">core.JniMethod</h3>
+<p class="default_text">This class represents a class method within Java Native Interface (JNI) context.</p>
+<h3 id="core_jniclass">core.JniClass</h3>
+<p class="default_text">This class represents a Java class within the Java Native Interface (JNI).</p>
+<h3 id="core_nullpointerexception">core.NullPointerException</h3>
+<p class="default_text">This exception can be thrown in case a called reference is null.</p>
+<h3 id="core_eventnothandledexception">core.EventNotHandledException</h3>
+<p class="default_text">This exception can be thrown in case an event is not handled.</p>
+<h3 id="core_illegalargumentexception">core.IllegalArgumentException</h3>
+<p class="default_text">This exception can be thrown in case a passed argument is illegal, which can be individually interpreted.</p>
+<h3 id="core_fileoperationexception">core.FileOperationException</h3>
+<p class="default_text">This exception can be thrown in case a file could not be processed, like opened or being read.</p>
+<h3 id="core_illegalarithmeticoperationexception">core.IllegalArithmeticOperationException</h3>
+<p class="default_text">This exception can be thrown in case an arithmetic operation is illegal. One example would be the division by zero.</p>
+<h3 id="core_filenotfoundexception">core.FileNotFoundException</h3>
+<p class="default_text">This exception can be thrown in case a file could not be found.</p>
+<h3 id="core_incompletejsonexception">core.IncompleteJsonException</h3>
+<p class="default_text">This exception can be thrown when a passed JSON is incomplete - e.g. if a key is missing.</p>
+<h3 id="core_notimplementedexception">core.NotImplementedException</h3>
+<p class="default_text">This exception can be thrown in case a called method is not implemented.</p>
+<h3 id="core_indexoutofboundsexception">core.IndexOutOfBoundsException</h3>
+<p class="default_text">This exception can be thrown in case an index of an array like structure is out of bounds.</p>
+<h3 id="core_exception">core.Exception</h3>
+<p class="default_text">This a base exception that can be thrown in any scenario.</p>
 <h3 id="boxing_integer">boxing.Integer</h3>
 <p class="default_text">This class represents the primitive datatype int and provides functionalities for arithmetic operations and string representation.</p>
 <h3 id="boxing_boolean">boxing.Boolean</h3>

include/ls-std/core/Class.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-07
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'Class', package: 'core')
+ * @doc: core.Class.description('This class represents a base class offering minimal reflection on the class name.')
  * */
 
 namespace ls::std::core

include/ls-std/core/ConditionalFunctionExecutor.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-13
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'ConditionalFunctionExecutor', package: 'core')
+ * @doc: core.ConditionalFunctionExecutor.description('This class can execute any method matching a specific signature based on a specific condition.')
  * */
 
 namespace ls::std::core

include/ls-std/core/LibraryVersion.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-05-02
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'LibraryVersion', package: 'core')
+ * @doc: core.LibraryVersion.description('This class provides the version information of this library.')
  * */
 
 namespace ls::std::core

include/ls-std/core/Version.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-09-27
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'Version', package: 'core')
+ * @doc: core.Version.description('This class represents a semantic versioning scheme.')
  * */
 
 namespace ls::std::core

include/ls-std/core/evaluator/EmptyStringArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-08
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'EmptyStringArgumentEvaluator', package: 'core')
+ * @doc: core.EmptyStringArgumentEvaluator.description('This class evaluates whether a passed string is empty.')
  * */
 
 namespace ls::std::core

include/ls-std/core/evaluator/IndexOutOfBoundsEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'IndexOutOfBoundsEvaluator', package: 'core')
+ * @doc: core.IndexOutOfBoundsEvaluator.description('This class evaluates whether a passed index is out of bounds.')
  * */
 
 namespace ls::std::core

include/ls-std/core/evaluator/NullPointerArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-08
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'NullPointerArgumentEvaluator', package: 'core')
+ * @doc: core.NullPointerArgumentEvaluator.description('This class evaluates whether a passed shared pointer argument is null.')
  * */
 
 namespace ls::std::core

include/ls-std/core/evaluator/NullPointerEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-08
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'NullPointerEvaluator', package: 'core')
+ * @doc: core.NullPointerEvaluator.description('This class evaluates whether a passed shared pointer reference is null.')
  * */
 
 namespace ls::std::core

include/ls-std/core/evaluator/RawNullPointerArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-05-23
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'RawNullPointerArgumentEvaluator', package: 'core')
+ * @doc: core.RawNullPointerArgumentEvaluator.description('This class evaluates whether a passed raw pointer argument is null.')
  * */
 
 namespace ls::std::core

include/ls-std/core/evaluator/RawNullPointerEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-05-24
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'RawNullPointerEvaluator', package: 'core')
+ * @doc: core.RawNullPointerEvaluator.description('This class evaluates whether a passed raw pointer reference is null.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/EventNotHandledException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-05-27
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'EventNotHandledException', package: 'core')
+ * @doc: core.EventNotHandledException.description('This exception can be thrown in case an event is not handled.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/Exception.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-22
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'Exception', package: 'core')
+ * @doc: core.Exception.description('This a base exception that can be thrown in any scenario.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/ExceptionMessage.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-07
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'ExceptionMessage', package: 'core')
+ * @doc: core.ExceptionMessage.description('This is the message container being used by these libraries' provided exceptions.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/FileNotFoundException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-17
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'FileNotFoundException', package: 'core')
+ * @doc: core.FileNotFoundException.description('This exception can be thrown in case a file could not be found.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/FileOperationException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-15
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'FileOperationException', package: 'core')
+ * @doc: core.FileOperationException.description('This exception can be thrown in case a file could not be processed, like opened or being read.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/IllegalArgumentException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-09
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'IllegalArgumentException', package: 'core')
+ * @doc: core.IllegalArgumentException.description('This exception can be thrown in case a passed argument is illegal, which can be individually interpreted.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/IllegalArithmeticOperationException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-07
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'IllegalArithmeticOperationException', package: 'core')
+ * @doc: core.IllegalArithmeticOperationException.description('This exception can be thrown in case an arithmetic operation is illegal. One example would be the division by zero.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/IncompleteJsonException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-04-30
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'IncompleteJsonException', package: 'core')
+ * @doc: core.IncompleteJsonException.description('This exception can be thrown when a passed JSON is incomplete - e.g. if a key is missing.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/IndexOutOfBoundsException.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'IndexOutOfBoundsException', package: 'core')
+ * @doc: core.IndexOutOfBoundsException.description('This exception can be thrown in case an index of an array like structure is out of bounds.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/NotImplementedException.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-27
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'NotImplementedException', package: 'core')
+ * @doc: core.NotImplementedException.description('This exception can be thrown in case a called method is not implemented.')
  * */
 
 namespace ls::std::core

include/ls-std/core/exception/NullPointerException.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-06
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'NullPointerException', package: 'core')
+ * @doc: core.NullPointerException.description('This exception can be thrown in case a called reference is null.')
  * */
 
 namespace ls::std::core

include/ls-std/core/jni/JniApi.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-07
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'JniApi', package: 'core')
+ * @doc: core.JniApi.description('This class represents an API for the Java Native Interface (JNI) wrapping basic JNI end points.')
  * */
 
 namespace ls::std::core::experimental

include/ls-std/core/jni/JniClass.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-07
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -22,6 +22,7 @@
 
 /*
  * @doc: class(name: 'JniClass', package: 'core')
+ * @doc: core.JniClass.description('This class represents a Java class within the Java Native Interface (JNI).')
  * */
 
 namespace ls::std::core::experimental

include/ls-std/core/jni/JniClassParameter.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-07
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'JniClassParameter', package: 'core')
+ * @doc: core.JniClassParameter.description('This class holds important information for the usage of the Java Native Interface (JNI), like Java environment or a specific Java object.')
  * */
 
 namespace ls::std::core::experimental

include/ls-std/core/jni/JniMethod.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-08
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'JniMethod', package: 'core')
+ * @doc: core.JniMethod.description('This class represents a class method within Java Native Interface (JNI) context.')
  * */
 
 namespace ls::std::core::experimental

include/ls-std/core/jni/JniReturnValue.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-08
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'JniReturnValue', package: 'core')
+ * @doc: core.JniReturnValue.description('This class represents a method return value of a Java class within Java Native Interface (JNI) context.')
  * */
 
 namespace ls::std::core::experimental