Ver código fonte

Add class list documentation for time module

Patrick-Christopher Mattulat 6 meses atrás
pai
commit
72e8aec532

+ 5 - 1
include/ls-std/time/Date.hpp

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

+ 5 - 1
include/ls-std/time/common/DateParameter.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-29
-* Changed:         2023-03-31
+* Changed:         2024-05-25
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <ls-std/time/type/DateParameterTypes.hpp>
 
+/*
+ * @class(name: 'DateParameter', package: 'Time')
+ * */
+
 namespace ls::std::time
 {
   class LS_STD_DYNAMIC_GOAL DateParameter

+ 5 - 1
include/ls-std/time/common/DateParameterMapper.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-03-31
-* Changed:         2023-04-01
+* Changed:         2024-05-25
 *
 * */
 
@@ -17,6 +17,10 @@
   #include <windows.h>
 #endif
 
+/*
+ * @class(name: 'DateParameterMapper', package: 'Time')
+ * */
+
 namespace ls::std::time
 {
   class LS_STD_DYNAMIC_GOAL DateParameterMapper

+ 5 - 1
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:         2023-04-10
+* Changed:         2024-05-25
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <ls-std/time/common/DateParameter.hpp>
 
+/*
+ * @class(name: 'JniDateParameterMapper', package: 'Time')
+ * */
+
 namespace ls::std::time::experimental
 {
   class LS_STD_DYNAMIC_GOAL JniDateParameterMapper

+ 5 - 1
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:         2023-04-01
+* Changed:         2024-05-25
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <cstdint>
 #include <ls-std/time/type/DateParameterTypes.hpp>
 
+/*
+ * @class(name: 'PosixClock', package: 'Time')
+ * */
+
 namespace ls::std::time
 {
   class PosixClock : public ls::std::time::IClock

+ 5 - 1
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:         2023-05-18
+* Changed:         2024-05-25
 *
 * */
 
@@ -19,6 +19,10 @@
 #include <memory>
 #include <string>
 
+/*
+ * @class(name: 'SystemTime', package: 'Time')
+ * */
+
 namespace ls::std::time
 {
   class LS_STD_DYNAMIC_GOAL SystemTime : public ls::std::core::Class

+ 5 - 1
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:         2023-05-18
+* Changed:         2024-05-25
 *
 * */
 
@@ -14,6 +14,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <memory>
 
+/*
+ * @class(name: 'SystemTimeParameter', package: 'Time')
+ * */
+
 namespace ls::std::time
 {
   class LS_STD_DYNAMIC_GOAL SystemTimeParameter

+ 5 - 1
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:         2023-04-01
+* Changed:         2024-05-25
 *
 * */
 
@@ -13,6 +13,10 @@
 #include "IClock.hpp"
 #include <ls-std/os/dynamic-goal.hpp>
 
+/*
+ * @class(name: 'WindowsClock', package: 'Time')
+ * */
+
 namespace ls::std::time
 {
   class LS_STD_DYNAMIC_GOAL WindowsClock : public ls::std::time::IClock