Add basic package documentation

include/ls-std/ls-std-boxing.hpp

@@ -3,13 +3,18 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-05-13
- * Changed:         2023-02-03
+ * Changed:         2024-05-23
  *
  * */
 
 #ifndef LS_STD_LS_STD_BOXING_HPP
 #define LS_STD_LS_STD_BOXING_HPP
 
+/*
+ * @package(name: 'Boxing')
+ * @Boxing.description('This package provides functionalities for wrapping primitive datatypes (boolean, double, float, int, long, string). Wrapping those types would enable a developer to provide string representations, or parsing from strings to convert them back into their primitive forms. Additionally, these boxing types come with a great selection of operators and convenient functions.')
+ * */
+
 #include <ls-std/boxing/Boolean.hpp>
 #include <ls-std/boxing/Double.hpp>
 #include <ls-std/boxing/Float.hpp>

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

@@ -3,13 +3,18 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-05-13
- * Changed:         2023-05-24
+ * Changed:         2024-05-23
  *
  * */
 
 #ifndef LS_STD_LS_STD_CORE_HPP
 #define LS_STD_LS_STD_CORE_HPP
 
+/*
+ * @package(name: 'Core')
+ * @Core.description('This package provides a base class, which can be used to provide simple class reflection. Other functionalities of this package include customized exceptions, basic interfaces and convenient types.')
+ * */
+
 #include <ls-std/core/evaluator/EmptyStringArgumentEvaluator.hpp>
 #include <ls-std/core/evaluator/IndexOutOfBoundsEvaluator.hpp>
 #include <ls-std/core/evaluator/NullPointerArgumentEvaluator.hpp>

include/ls-std/ls-std-encoding.hpp

@@ -3,13 +3,18 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-05-17
- * Changed:         2023-02-03
+ * Changed:         2024-05-23
  *
  * */
 
 #ifndef LS_STD_LS_STD_ENCODING_HPP
 #define LS_STD_LS_STD_ENCODING_HPP
 
+/*
+ * @package(name: 'Encoding')
+ * @Encoding.description('This package provides encoding functionalities, which in the current scope is limited to Base64. This would also include the provision of a Base-64-CLI-tool.')
+ * */
+
 #include <ls-std/encoding/Base64.hpp>
 
 #endif

include/ls-std/ls-std-event.hpp

@@ -3,13 +3,18 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-05-14
- * Changed:         2023-02-03
+ * Changed:         2024-05-23
  *
  * */
 
 #ifndef LS_STD_LS_STD_EVENT_HPP
 #define LS_STD_LS_STD_EVENT_HPP
 
+/*
+ * @package(name: 'Event')
+ * @Event.description('This package provides an event manager and the functionality to through events.')
+ * */
+
 #include <ls-std/event/serialization/SerializableJsonEvent.hpp>
 
 #include <ls-std/event/Event.hpp>

include/ls-std/ls-std-io.hpp

@@ -3,13 +3,18 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-05-14
- * Changed:         2023-02-22
+ * Changed:         2024-05-23
  *
  * */
 
 #ifndef LS_STD_LS_STD_IO_HPP
 #define LS_STD_LS_STD_IO_HPP
 
+/*
+ * @package(name: 'IO')
+ * @IO.description('This package provides cross-platform functionalities for handling files, parsing and writing XML, logging, parsing and writing SP-files (.INI-based files).')
+ * */
+
 #include <ls-std/io/evaluator/FileExistenceEvaluator.hpp>
 
 #include <ls-std/io/logging/LogLevel.hpp>

include/ls-std/ls-std-time.hpp

@@ -3,13 +3,18 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-05-16
- * Changed:         2023-04-01
+ * Changed:         2024-05-23
  *
  * */
 
 #ifndef LS_STD_LS_STD_TIME_HPP
 #define LS_STD_LS_STD_TIME_HPP
 
+/*
+ * @package(name: 'Time')
+ * @Time.description('This package provides convenient time functionalities and data structures, like a Date class for representing a date or SystemTime for setting a systems local time.')
+ * */
+
 #include <ls-std/time/common/DateParameter.hpp>
 #include <ls-std/time/common/DateParameterMapper.hpp>