Преглед изворни кода

Add missing documentation hint

Patrick-Christopher Mattulat пре 2 месеци
родитељ
комит
2dead6cf3f
5 измењених фајлова са 10 додато и 18 уклоњено
  1. 1 1
      CMakeLists.txt
  2. 4 12
      README.md
  3. 1 1
      doc/coline.html
  4. 2 2
      source/ls-std/core/LibraryVersion.cpp
  5. 2 2
      test/cases/core/LibraryVersionTest.cpp

+ 1 - 1
CMakeLists.txt

@@ -11,7 +11,7 @@
 ##########################################################
 
 cmake_minimum_required(VERSION 3.30)
-project(ls-std VERSION 2024.1.0.0)
+project(ls-std VERSION 2024.1.0.1)
 
 set(MODULE_NAME_BOXING ls-std-boxing)
 set(MODULE_NAME_CORE ls-std-core)

+ 4 - 12
README.md

@@ -1,4 +1,4 @@
-# Lynar Studios - Standard Library 2024.1.0.0 #
+# Lynar Studios - Standard Library 2024.1.0.1 #
 
 This is a cross-platform standard library written in C++ offering functionalities you would usually miss in C++'s standard library, especially if you would search for cross-platform implementations.  
 This library has been tested on __Windows__, __Linux__ and __MacOS__ systems.
@@ -34,19 +34,11 @@ A __Date__ class comes with this submodule, which you can use to represent a dat
 
 #### Features ####
 
-- a reworked version of Event handling is now available, which orients more on nowadays standards - this implementation
-  is replacing the old Event based implementation
-- this library is now licensed under the __LGPL v3__ license
-- a class documentation has been added, which was generated by Coline code generation tool
+- none
 
 #### Improvements ####
 
-- an OS-specific initialization-script is now being provided for setting up the project and preparing it for the developer for code-contribution
-- the library version scheme is now reflecting major-, minor- and patch-level additionally to the year of release to
-  rightfully reflect on the change impact, resulting into the format YYYY.MAJOR.MINOR.PATCH
-- CMake required minimum version was upgraded to __3.30.0__
-- GCC required minimum compiler version was upgraded to __14.2__
-- Google Test version was upgraded to __1.15.2__
+- README.md file now contains information on documentation
 
 #### Fixes ####
 
@@ -55,7 +47,7 @@ A __Date__ class comes with this submodule, which you can use to represent a dat
 ---
 ### Documentation ###
 
-You can find a detailed documentation on Lynar Studios Website: lynarstudios.com
+A simple HTML documentation file generated with Coline code documentation tool can be found inside the __doc__ folder of the project's root directory.
 
 ---
 ### License ###

+ 1 - 1
doc/coline.html

@@ -55,7 +55,7 @@ li.class_li
 </style>
 </head>
 <body>
-<h1>Lynar Studios - Standard Library - v2024.1.0.0 Documentation</h1>
+<h1>Lynar Studios - Standard Library - v2024.1.0.1 Documentation</h1>
 <h2>Packages</h2>
 <ul id="package_list">
 <li class="package_li"><a class="default_link_layout" href="#package_boxing">boxing</a></li>

+ 2 - 2
source/ls-std/core/LibraryVersion.cpp

@@ -3,7 +3,7 @@
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2023-02-05
-* Changed:         2024-09-14
+* Changed:         2024-12-29
 *
 * */
 
@@ -18,5 +18,5 @@ LibraryVersion::~LibraryVersion() = default;
 
 string LibraryVersion::getVersion()
 {
-  return "2024.1.0.0";
+  return "2024.1.0.1";
 }

+ 2 - 2
test/cases/core/LibraryVersionTest.cpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2021-05-02
- * Changed:         2024-09-14
+ * Changed:         2024-12-29
  *
  * */
 
@@ -25,6 +25,6 @@ namespace
 
   TEST_F(LibraryVersionTest, getVersion)
   {
-    ASSERT_STREQ("2024.1.0.0", LibraryVersion::getVersion().c_str());
+    ASSERT_STREQ("2024.1.0.1", LibraryVersion::getVersion().c_str());
   }
 }