Add class documentation for time module

doc/coline.html

@@ -251,6 +251,22 @@ li.class_li
 <p class="default_text">This class represents a string and provides operations, like filling and searching.</p>
 <h3 id="boxing_long">boxing.Long</h3>
 <p class="default_text">This class represents the primitive datatype long and provides functionalities for arithmetic operations and string representation.</p>
+<h3 id="time_date">time.Date</h3>
+<p class="default_text">This class represents a date and provides functionalities for string representation, arithmetic operations and time comparison.</p>
+<h3 id="time_dateparameter">time.DateParameter</h3>
+<p class="default_text">This class holds information of a date processed by this library.</p>
+<h3 id="time_dateparametermapper">time.DateParameterMapper</h3>
+<p class="default_text">This class maps date information to either an internal POSIX clock or an internal Windows clock, which can then be processed for setting the system time.</p>
+<h3 id="time_jnidateparametermapper">time.JniDateParameterMapper</h3>
+<p class="default_text">This mapper is converting a date Java class to a date model class of this library.</p>
+<h3 id="time_systemtimeparameter">time.SystemTimeParameter</h3>
+<p class="default_text">This class holds information for setting the system time.</p>
+<h3 id="time_posixclock">time.PosixClock</h3>
+<p class="default_text">This is a POSIX based internal time.</p>
+<h3 id="time_systemtime">time.SystemTime</h3>
+<p class="default_text">This class represents the system time and can be set. This would require root privileges.</p>
+<h3 id="time_windowsclock">time.WindowsClock</h3>
+<p class="default_text">This is a Windows based internal time.</p>
 <h3 id="encoding_base64">encoding.Base64</h3>
 <p class="default_text">This class can encode and decode the Base64 format.</p>
 <h3 id="event_event">event.Event</h3>

include/ls-std/time/Date.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-14
- * Changed:         2024-09-09
+ * Changed:         2024-09-11
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'Date', package: 'time')
+ * @doc: time.Date.description('This class represents a date and provides functionalities for string representation, arithmetic operations and time comparison.')
  * */
 
 namespace ls::std::time

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-29
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'DateParameter', package: 'time')
+ * @doc: time.DateParameter.description('This class holds information of a date processed by this library.')
  * */
 
 namespace ls::std::time

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-31
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -19,6 +19,7 @@
 
 /*
  * @doc: class(name: 'DateParameterMapper', package: 'time')
+ * @doc: time.DateParameterMapper.description('This class maps date information to either an internal POSIX clock or an internal Windows clock, which can then be processed for setting the system time.')
  * */
 
 namespace ls::std::time

include/ls-std/time/common/jni/JniDateParameterMapper.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-09
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'JniDateParameterMapper', package: 'time')
+ * @doc: time.JniDateParameterMapper.description('This mapper is converting a date Java class to a date model class of this library.')
  * */
 
 namespace ls::std::time::experimental

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-15
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'PosixClock', package: 'time')
+ * @doc: time.PosixClock.description('This is a POSIX based internal time.')
  * */
 
 namespace ls::std::time

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-07
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -21,6 +21,7 @@
 
 /*
  * @doc: class(name: 'SystemTime', package: 'time')
+ * @doc: time.SystemTime.description('This class represents the system time and can be set. This would require root privileges.')
  * */
 
 namespace ls::std::time

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-15
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'SystemTimeParameter', package: 'time')
+ * @doc: time.SystemTimeParameter.description('This class holds information for setting the system time.')
  * */
 
 namespace ls::std::time

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-04-01
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'WindowsClock', package: 'time')
+ * @doc: time.WindowsClock.description('This is a Windows based internal time.')
  * */
 
 namespace ls::std::time