Add class documentation for io module

doc/coline.html

@@ -189,6 +189,102 @@ li.class_li
 <li class="class_li"><a class="default_link_layout" href="#time_windowsclock">WindowsClock</a></li>
 </ul>
 <h2>Classes</h2>
+<h3 id="io_filewriter">io.FileWriter</h3>
+<p class="default_text">This class can write to a file.</p>
+<h3 id="io_filepathseparatormatch">io.FilePathSeparatorMatch</h3>
+<p class="default_text">This class can filter file path separators.</p>
+<h3 id="io_fileoutputstream">io.FileOutputStream</h3>
+<p class="default_text">This class can be used for writing to a file stream.</p>
+<h3 id="io_storablefile">io.StorableFile</h3>
+<p class="default_text">This class can be used to store any serialized information to a file.</p>
+<h3 id="io_newline">io.NewLine</h3>
+<p class="default_text">This class can be used as new line based on the preferred operating system. Currently, Windows and Unix-like operating systems are supported.</p>
+<h3 id="io_filereader">io.FileReader</h3>
+<p class="default_text">This class can read the content of a file and return it as byte field.</p>
+<h3 id="io_file">io.File</h3>
+<p class="default_text">This class represents a file in the file system and provides functionalities for location, operations and fetching property information.</p>
+<h3 id="io_standardoutputwriter">io.StandardOutputWriter</h3>
+<p class="default_text">This class can be used to write a string to stdout.</p>
+<h3 id="io_filepathseparator">io.FilePathSeparator</h3>
+<p class="default_text">This class represents the OS specific separator withing file paths on either Windows- or Unix-like operating systems.</p>
+<h3 id="io_fileexistenceevaluator">io.FileExistenceEvaluator</h3>
+<p class="default_text">This class evaluates whether a file exists and throws an exception in case it does not.</p>
+<h3 id="io_sectionpairmessageformatter">io.SectionPairMessageFormatter</h3>
+<p class="default_text">This message formatter replaces new line sequences, which are OS specific, to a readable tag for error message formatting.</p>
+<h3 id="io_sectionpairfilereaderparameter">io.SectionPairFileReaderParameter</h3>
+<p class="default_text">This class holds evaluators and the document instance for Section Pair file reading.</p>
+<h3 id="io_sectionpairfilereader">io.SectionPairFileReader</h3>
+<p class="default_text">This class reads a Section Pair file and writes it to a Section Pair document instance.</p>
+<h3 id="io_sectionpairsectionargumentevaluator">io.SectionPairSectionArgumentEvaluator</h3>
+<p class="default_text">This class checks whether a whole section argument is valid and throws an exception if that is not the case.</p>
+<h3 id="io_sectionpairvalueargumentevaluator">io.SectionPairValueArgumentEvaluator</h3>
+<p class="default_text">This class checks whether a value argument is valid and throws an exception if that is not the case.</p>
+<h3 id="io_sectionpairrowlistvalueargumentevaluator">io.SectionPairRowListValueArgumentEvaluator</h3>
+<p class="default_text">This class checks whether a row list value argument is valid and throws an exception if that is not the case.</p>
+<h3 id="io_sectionpairrowsinglevalueargumentevaluator">io.SectionPairRowSingleValueArgumentEvaluator</h3>
+<p class="default_text">This class checks whether a single row value argument is valid and throws an exception if that is not the case.</p>
+<h3 id="io_sectionpairrowargumentevaluator">io.SectionPairRowArgumentEvaluator</h3>
+<p class="default_text">This class checks whether a row argument is valid and throws an exception if that is not the case.</p>
+<h3 id="io_sectionpairidentifierargumentevaluator">io.SectionPairIdentifierArgumentEvaluator</h3>
+<p class="default_text">This class checks whether an identifier argument is valid and throws an exception if that is not the case.</p>
+<h3 id="io_sectionpairidentifiervalidator">io.SectionPairIdentifierValidator</h3>
+<p class="default_text">This validator checks whether a string is a valid Section Pair identifier.</p>
+<h3 id="io_sectionpairsectionvalidator">io.SectionPairSectionValidator</h3>
+<p class="default_text">This validator checks whether a content is a valid Section Pair section.</p>
+<h3 id="io_sectionpairrowlistvaluevalidator">io.SectionPairRowListValueValidator</h3>
+<p class="default_text">This validator checks whether a content is a valid Section Pair row list value.</p>
+<h3 id="io_sectionpairrowsinglevaluevalidator">io.SectionPairRowSingleValueValidator</h3>
+<p class="default_text">This validator checks whether a content is a valid Section Pair row single value.</p>
+<h3 id="io_sectionpairdocumentvalidator">io.SectionPairDocumentValidator</h3>
+<p class="default_text">This validator checks whether a content is a valid Section Pair document.</p>
+<h3 id="io_sectionpairvaluevalidator">io.SectionPairValueValidator</h3>
+<p class="default_text">This validator checks whether a content is a valid Section Pair value.</p>
+<h3 id="io_sectionpairfileextensionvalidator">io.SectionPairFileExtensionValidator</h3>
+<p class="default_text">This validator checks whether a file name has a valid Section Pair file extension.</p>
+<h3 id="io_sectionpairrowvalidator">io.SectionPairRowValidator</h3>
+<p class="default_text">This validator checks whether a content is a valid Section Pair row.</p>
+<h3 id="io_serializablesectionpairsection">io.SerializableSectionPairSection</h3>
+<p class="default_text">This class can serialize a Section Pair section for file persistence.</p>
+<h3 id="io_serializablesectionpairrowsinglevalue">io.SerializableSectionPairRowSingleValue</h3>
+<p class="default_text">This class can serialize a Section Pair single value for file persistence.</p>
+<h3 id="io_serializablesectionpairrow">io.SerializableSectionPairRow</h3>
+<p class="default_text">This class can serialize a Section Pair row for file persistence.</p>
+<h3 id="io_serializablesectionpairrowlistvalue">io.SerializableSectionPairRowListValue</h3>
+<p class="default_text">This class can serialize a Section Pair row list value for file persistence.</p>
+<h3 id="io_serializablesectionpairparameter">io.SerializableSectionPairParameter</h3>
+<p class="default_text">This class is holding information for Section Pair serialization.</p>
+<h3 id="io_serializablesectionpairdocument">io.SerializableSectionPairDocument</h3>
+<p class="default_text">This class can serialize a Section Pair document for file persistence.</p>
+<h3 id="io_sectionpairrowvalue">io.SectionPairRowValue</h3>
+<p class="default_text">This class represents a Section Pair row value.</p>
+<h3 id="io_sectionpairdocument">io.SectionPairDocument</h3>
+<p class="default_text">This class represents a whole Section Pair document.</p>
+<h3 id="io_sectionpairrowlistvalue">io.SectionPairRowListValue</h3>
+<p class="default_text">This class represents a Section Pair row list value.</p>
+<h3 id="io_sectionpairrow">io.SectionPairRow</h3>
+<p class="default_text">This class represents a Section Pair row.</p>
+<h3 id="io_sectionpairsection">io.SectionPairSection</h3>
+<p class="default_text">This class represents a Section Pair section.</p>
+<h3 id="io_sectionpairrowsinglevalue">io.SectionPairRowSingleValue</h3>
+<p class="default_text">This class represents a Section Pair row single value.</p>
+<h3 id="io_xmldeclaration">io.XmlDeclaration</h3>
+<p class="default_text">This class represents an XML declaration and can be serialized to an XML tag.</p>
+<h3 id="io_xmlparser">io.XmlParser</h3>
+<p class="default_text">This class parses a whole XML tree in form of an XML document.</p>
+<h3 id="io_xmlreader">io.XmlReader</h3>
+<p class="default_text">This class reads an XML file and returns an XML document.</p>
+<h3 id="io_xmldocument">io.XmlDocument</h3>
+<p class="default_text">This class represents a whole XML document and can be serialized to a whole XML tree.</p>
+<h3 id="io_xmlattribute">io.XmlAttribute</h3>
+<p class="default_text">This class represents an XML attribute and can be serialized to an XML tag.</p>
+<h3 id="io_xmlparseparameter">io.XmlParseParameter</h3>
+<p class="default_text">This class holds information regarding parsing an XML tree.</p>
+<h3 id="io_xmlnode">io.XmlNode</h3>
+<p class="default_text">This class represents an XML node and can be serialized to an XML tree.</p>
+<h3 id="io_logger">io.Logger</h3>
+<p class="default_text">This is a logger which can log to any implemented target.</p>
+<h3 id="io_loglevel">io.LogLevel</h3>
+<p class="default_text">This class represents the log level controlling how noisy a log should be.</p>
 <h3 id="core_class">core.Class</h3>
 <p class="default_text">This class represents a base class offering minimal reflection on the class name.</p>
 <h3 id="core_libraryversion">core.LibraryVersion</h3>
@@ -225,6 +321,8 @@ li.class_li
 <p class="default_text">This exception can be thrown in case an event is not handled.</p>
 <h3 id="core_illegalargumentexception">core.IllegalArgumentException</h3>
 <p class="default_text">This exception can be thrown in case a passed argument is illegal, which can be individually interpreted.</p>
+<h3 id="core_exceptionmessage">core.ExceptionMessage</h3>
+<p class="default_text">This is the message container being used by these libraries provided exceptions.</p>
 <h3 id="core_fileoperationexception">core.FileOperationException</h3>
 <p class="default_text">This exception can be thrown in case a file could not be processed, like opened or being read.</p>
 <h3 id="core_illegalarithmeticoperationexception">core.IllegalArithmeticOperationException</h3>

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-07
-* Changed:         2024-09-11
+* Changed:         2024-09-13
 *
 * */
 
@@ -15,7 +15,7 @@
 
 /*
  * @doc: class(name: 'ExceptionMessage', package: 'core')
- * @doc: core.ExceptionMessage.description('This is the message container being used by these libraries' provided exceptions.')
+ * @doc: core.ExceptionMessage.description('This is the message container being used by these libraries provided exceptions.')
  * */
 
 namespace ls::std::core

include/ls-std/io/File.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-15
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -25,6 +25,7 @@
 
 /*
  * @doc: class(name: 'File', package: 'io')
+ * @doc: io.File.description('This class represents a file in the file system and provides functionalities for location, operations and fetching property information.')
  * */
 
 namespace ls::std::io

include/ls-std/io/FileOutputStream.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-20
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'FileOutputStream', package: 'io')
+ * @doc: io.FileOutputStream.description('This class can be used for writing to a file stream.')
  * */
 
 namespace ls::std::io

include/ls-std/io/FilePathSeparator.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-15
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'FilePathSeparator', package: 'io')
+ * @doc: io.FilePathSeparator.description('This class represents the OS specific separator withing file paths on either Windows- or Unix-like operating systems.')
  * */
 
 namespace ls::std::io

include/ls-std/io/FilePathSeparatorMatch.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-15
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -14,6 +14,7 @@
 
 /*
  * @doc: class(name: 'FilePathSeparatorMatch', package: 'io')
+ * @doc: io.FilePathSeparatorMatch.description('This class can filter file path separators.')
  * */
 
 namespace ls::std::io

include/ls-std/io/FileReader.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-17
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'FileReader', package: 'io')
+ * @doc: io.FileReader.description('This class can read the content of a file and return it as byte field.')
  * */
 
 namespace ls::std::io

include/ls-std/io/FileWriter.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-17
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'FileWriter', package: 'io')
+ * @doc: io.FileWriter.description('This class can write to a file.')
  * */
 
 namespace ls::std::io

include/ls-std/io/NewLine.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-18
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'NewLine', package: 'io')
+ * @doc: io.NewLine.description('This class can be used as new line based on the preferred operating system. Currently, Windows and Unix-like operating systems are supported.')
  * */
 
 namespace ls::std::io

include/ls-std/io/StandardOutputWriter.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-06
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'StandardOutputWriter', package: 'io')
+ * @doc: io.StandardOutputWriter.description('This class can be used to write a string to stdout.')
  * */
 
 namespace ls::std::io

include/ls-std/io/StorableFile.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-19
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'StorableFile', package: 'io')
+ * @doc: io.StorableFile.description('This class can be used to store any serialized information to a file.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-21
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'FileExistenceEvaluator', package: 'io')
+ * @doc: io.FileExistenceEvaluator.description('This class evaluates whether a file exists and throws an exception in case it does not.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-20
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'LogLevel', package: 'io')
+ * @doc: io.LogLevel.description('This class represents the log level controlling how noisy a log should be.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-08-20
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -21,6 +21,7 @@
 
 /*
  * @doc: class(name: 'Logger', package: 'io')
+ * @doc: io.Logger.description('This is a logger which can log to any implemented target.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/SectionPairMessageFormatter.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-22
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -15,6 +15,7 @@
 
 /*
  * @doc: class(name: 'SectionPairMessageFormatter', package: 'io')
+ * @doc: io.SectionPairMessageFormatter.description('This message formatter replaces new line sequences, which are OS specific, to a readable tag for error message formatting.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/evaluator/SectionPairIdentifierArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-09
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairIdentifierArgumentEvaluator', package: 'io')
+ * @doc: io.SectionPairIdentifierArgumentEvaluator.description('This class checks whether an identifier argument is valid and throws an exception if that is not the case.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/evaluator/SectionPairRowArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-20
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowArgumentEvaluator', package: 'io')
+ * @doc: io.SectionPairRowArgumentEvaluator.description('This class checks whether a row argument is valid and throws an exception if that is not the case.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/evaluator/SectionPairRowListValueArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-20
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowListValueArgumentEvaluator', package: 'io')
+ * @doc: io.SectionPairRowListValueArgumentEvaluator.description('This class checks whether a row list value argument is valid and throws an exception if that is not the case.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/evaluator/SectionPairRowSingleValueArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-19
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowSingleValueArgumentEvaluator', package: 'io')
+ * @doc: io.SectionPairRowSingleValueArgumentEvaluator.description('This class checks whether a single row value argument is valid and throws an exception if that is not the case.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/evaluator/SectionPairSectionArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-20
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairSectionArgumentEvaluator', package: 'io')
+ * @doc: io.SectionPairSectionArgumentEvaluator.description('This class checks whether a whole section argument is valid and throws an exception if that is not the case.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/evaluator/SectionPairValueArgumentEvaluator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'SectionPairValueArgumentEvaluator', package: 'io')
+ * @doc: io.SectionPairValueArgumentEvaluator.description('This class checks whether a value argument is valid and throws an exception if that is not the case.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/model/SectionPairDocument.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-15
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -20,6 +20,7 @@
 
 /*
  * @doc: class(name: 'SectionPairDocument', package: 'io')
+ * @doc: io.SectionPairDocument.description('This class represents a whole Section Pair document.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/model/SectionPairRow.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-08
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -22,6 +22,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRow', package: 'io')
+ * @doc: io.SectionPairRow.description('This class represents a Section Pair row.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/model/SectionPairRowListValue.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowListValue', package: 'io')
+ * @doc: io.SectionPairRowListValue.description('This class represents a Section Pair row list value.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/model/SectionPairRowSingleValue.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -19,6 +19,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowSingleValue', package: 'io')
+ * @doc: io.SectionPairRowSingleValue.description('This class represents a Section Pair row single value.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/model/SectionPairRowValue.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-10
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowValue', package: 'io')
+ * @doc: io.SectionPairRowValue.description('This class represents a Section Pair row value.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/model/SectionPairSection.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-13
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -22,6 +22,7 @@
 
 /*
  * @doc: class(name: 'SectionPairSection', package: 'io')
+ * @doc: io.SectionPairSection.description('This class represents a Section Pair section.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/reader/SectionPairFileReader.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-21
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'SectionPairFileReader', package: 'io')
+ * @doc: io.SectionPairFileReader.description('This class reads a Section Pair file and writes it to a Section Pair document instance.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/reader/SectionPairFileReaderParameter.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-21
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -20,6 +20,7 @@
 
 /*
  * @doc: class(name: 'SectionPairFileReaderParameter', package: 'io')
+ * @doc: io.SectionPairFileReaderParameter.description('This class holds evaluators and the document instance for Section Pair file reading.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/serialization/SerializableSectionPairDocument.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-16
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -19,6 +19,7 @@
 
 /*
  * @doc: class(name: 'SerializableSectionPairDocument', package: 'io')
+ * @doc: io.SerializableSectionPairDocument.description('This class can serialize a Section Pair document for file persistence.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/serialization/SerializableSectionPairParameter.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-17
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -18,7 +18,8 @@
 
 /*
  * @doc: class(name: 'SerializableSectionPairParameter', package: 'io')
- * */
+ * @doc: io.SerializableSectionPairParameter.description('This class is holding information for Section Pair serialization.')
+ */
 
 namespace ls::std::io
 {

include/ls-std/io/section-pair/serialization/SerializableSectionPairRow.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-11
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -19,6 +19,7 @@
 
 /*
  * @doc: class(name: 'SerializableSectionPairRow', package: 'io')
+ * @doc: io.SerializableSectionPairRow.description('This class can serialize a Section Pair row for file persistence.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/serialization/SerializableSectionPairRowListValue.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-11
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -19,6 +19,7 @@
 
 /*
  * @doc: class(name: 'SerializableSectionPairRowListValue', package: 'io')
+ * @doc: io.SerializableSectionPairRowListValue.description('This class can serialize a Section Pair row list value for file persistence.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/serialization/SerializableSectionPairRowSingleValue.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-11
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'SerializableSectionPairRowSingleValue', package: 'io')
+ * @doc: io.SerializableSectionPairRowSingleValue.description('This class can serialize a Section Pair single value for file persistence.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/serialization/SerializableSectionPairSection.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-14
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -19,6 +19,7 @@
 
 /*
  * @doc: class(name: 'SerializableSectionPairSection', package: 'io')
+ * @doc: io.SerializableSectionPairSection.description('This class can serialize a Section Pair section for file persistence.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairDocumentValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-21
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairDocumentValidator', package: 'io')
+ * @doc: io.SectionPairDocumentValidator.description('This validator checks whether a content is a valid Section Pair document.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairFileExtensionValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-21
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairFileExtensionValidator', package: 'io')
+ * @doc: io.SectionPairFileExtensionValidator.description('This validator checks whether a file name has a valid Section Pair file extension.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairIdentifierValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-09
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'SectionPairIdentifierValidator', package: 'io')
+ * @doc: io.SectionPairIdentifierValidator.description('This validator checks whether a string is a valid Section Pair identifier.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairRowListValueValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-19
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowListValueValidator', package: 'io')
+ * @doc: io.SectionPairRowListValueValidator.description('This validator checks whether a content is a valid Section Pair row list value.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairRowSingleValueValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-19
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowSingleValueValidator', package: 'io')
+ * @doc: io.SectionPairRowSingleValueValidator.description('This validator checks whether a content is a valid Section Pair row single value.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairRowValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-20
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairRowValidator', package: 'io')
+ * @doc: io.SectionPairRowValidator.description('This validator checks whether a content is a valid Section Pair row.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairSectionValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-20
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'SectionPairSectionValidator', package: 'io')
+ * @doc: io.SectionPairSectionValidator.description('This validator checks whether a content is a valid Section Pair section.')
  * */
 
 namespace ls::std::io

include/ls-std/io/section-pair/validator/SectionPairValueValidator.hpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-09
-* Changed:         2024-09-09
+* Changed:         2024-09-13
 *
 * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'SectionPairValueValidator', package: 'io')
+ * @doc: io.SectionPairValueValidator.description('This validator checks whether a content is a valid Section Pair value.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-09-23
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'XmlAttribute', package: 'io')
+ * @doc: io.XmlAttribute.description('This class represents an XML attribute and can be serialized to an XML tag.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-09-27
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -16,6 +16,7 @@
 
 /*
  * @doc: class(name: 'XmlDeclaration', package: 'io')
+ * @doc: io.XmlDeclaration.description('This class represents an XML declaration and can be serialized to an XML tag.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-09-27
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'XmlDocument', package: 'io')
+ * @doc: io.XmlDocument.description('This class represents a whole XML document and can be serialized to a whole XML tree.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-09-24
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -18,6 +18,7 @@
 
 /*
  * @doc: class(name: 'XmlNode', package: 'io')
+ * @doc: io.XmlNode.description('This class represents an XML node and can be serialized to an XML tree.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-10-17
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -17,6 +17,7 @@
 
 /*
  * @doc: class(name: 'XmlParseParameter', package: 'io')
+ * @doc: io.XmlParseParameter.description('This class holds information regarding parsing an XML tree.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-25
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -21,6 +21,7 @@
 
 /*
  * @doc: class(name: 'XmlParser', package: 'io')
+ * @doc: io.XmlParser.description('This class parses a whole XML tree in form of an XML document.')
  * */
 
 namespace ls::std::io

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

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-10-08
- * Changed:         2024-09-09
+ * Changed:         2024-09-13
  *
  * */
 
@@ -21,6 +21,7 @@
 
 /*
  * @doc: class(name: 'XmlReader', package: 'io')
+ * @doc: io.XmlReader.description('This class reads an XML file and returns an XML document.')
  * */
 
 namespace ls::std::io