Add class documentation for event module

doc/coline.html

@@ -118,7 +118,9 @@ li.class_li
 <h4>Classes</h4>
 <ul id="event_class_list">
 <li class="class_li"><a class="default_link_layout" href="#event_event">Event</a></li>
+<li class="class_li"><a class="default_link_layout" href="#event_eventlistener">EventListener</a></li>
 <li class="class_li"><a class="default_link_layout" href="#event_eventmanager">EventManager</a></li>
+<li class="class_li"><a class="default_link_layout" href="#event_eventparameter">EventParameter</a></li>
 </ul>
 <h3 id="package_io">io</h3>
 <p class="default_text">This package provides cross-platform functionalities for handling files, parsing and writing XML, logging, parsing and writing SP-files (.INI-based files).</p>
@@ -251,5 +253,13 @@ li.class_li
 <p class="default_text">This class represents the primitive datatype long and provides functionalities for arithmetic operations and string representation.</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>
+<p class="default_text">This class represents an event that can be invoked.</p>
+<h3 id="event_eventlistener">event.EventListener</h3>
+<p class="default_text">An instance of this class can listen to any event. Usually, this class is used as base class of any class that must listen to an event.</p>
+<h3 id="event_eventmanager">event.EventManager</h3>
+<p class="default_text">This class can invoke all events known by subscribed listeners.</p>
+<h3 id="event_eventparameter">event.EventParameter</h3>
+<p class="default_text">This class holds parameters which can be sent during event invocation.</p>
 </body>
 </html>

include/ls-std/event/Event.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2024-05-16
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'Event', package: 'event')
+ * @doc: event.Event.description('This class represents an event that can be invoked.')
  * */
 
 namespace ls::std::event

include/ls-std/event/EventListener.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2024-05-16
-* Changed:         2024-05-30
+* Changed:         2024-09-11
 *
 * */
 
@@ -16,6 +16,11 @@
 #include <ls-std/event/type/EventTypes.hpp>
 #include <ls-std/os/dynamic-goal.hpp>
 
+/*
+ * @doc: class(name: 'EventListener', package: 'event')
+ * @doc: event.EventListener.description('An instance of this class can listen to any event. Usually, this class is used as base class of any class that must listen to an event.')
+ * */
+
 namespace ls::std::event
 {
   class LS_STD_DYNAMIC_GOAL EventListener : public ::std::enable_shared_from_this<EventListener>, public ls::std::core::Class
@@ -33,7 +38,7 @@ namespace ls::std::event
 
     protected:
 
-    ls::std::event::EventParameter parameter{};
+      ls::std::event::EventParameter parameter{};
 
     private:
 

include/ls-std/event/EventManager.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2024-05-16
-* Changed:         2024-09-09
+* Changed:         2024-09-11
 *
 * */
 
@@ -29,6 +29,7 @@ namespace ls::std::event::type
 
 /*
  * @doc: class(name: 'EventManager', package: 'event')
+ * @doc: event.EventManager.description('This class can invoke all events known by subscribed listeners.')
  * */
 
 namespace ls::std::event

include/ls-std/event/EventParameter.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2024-05-30
-* Changed:         2024-05-30
+* Changed:         2024-09-11
 *
 * */
 
@@ -14,6 +14,11 @@
 #include <ls-std/os/dynamic-goal.hpp>
 #include <string>
 
+/*
+ * @doc: class(name: 'EventParameter', package: 'event')
+ * @doc: event.EventParameter.description('This class holds parameters which can be sent during event invocation.')
+ * */
+
 namespace ls::std::event
 {
   class LS_STD_DYNAMIC_GOAL EventParameter