Ver código fonte

Add class list documentation for event module

Patrick-Christopher Mattulat 6 meses atrás
pai
commit
d8738797a9

+ 5 - 1
include/ls-std/event/Event.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-26
- * Changed:         2023-05-16
+ * Changed:         2024-05-24
  *
  * */
 
@@ -16,6 +16,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <memory>
 
+/*
+ * @class(name: 'Event', package: 'event')
+ * */
+
 namespace ls::std::event
 {
   class LS_STD_DYNAMIC_GOAL Event : public ls::std::core::Class

+ 5 - 1
include/ls-std/event/EventHandler.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-27
- * Changed:         2023-05-17
+ * Changed:         2024-05-24
  *
  * */
 
@@ -18,6 +18,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <memory>
 
+/*
+ * @class(name: 'EventHandler', package: 'event')
+ * */
+
 namespace ls::std::event
 {
   class LS_STD_DYNAMIC_GOAL EventHandler : public ls::std::event::Narrator

+ 5 - 1
include/ls-std/event/EventManager.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-27
- * Changed:         2023-05-17
+ * Changed:         2024-05-24
  *
  * */
 
@@ -18,6 +18,10 @@
 #include <map>
 #include <memory>
 
+/*
+ * @class(name: 'EventManager', package: 'event')
+ * */
+
 namespace ls::std::event
 {
   class LS_STD_DYNAMIC_GOAL EventManager : public ls::std::core::Class, public ls::std::core::interface_type::IEventSubscriber

+ 5 - 1
include/ls-std/event/Narrator.hpp

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

+ 5 - 1
include/ls-std/event/serialization/SerializableJsonEvent.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-12-07
- * Changed:         2023-05-19
+ * Changed:         2024-05-24
  *
  * */
 
@@ -17,6 +17,10 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <memory>
 
+/*
+ * @class(name: 'SerializableJsonEvent', package: 'event')
+ * */
+
 namespace ls::std::event
 {
   class LS_STD_DYNAMIC_GOAL SerializableJsonEvent : public ls::std::core::Class, public ls::std::core::interface_type::ISerializable

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

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