cosmetic

CMakeLists.txt

@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW) # enable new "MSVC runtime library selection" (https://cmake.org/cmake/help/latest/variable/CMAKE_MSVC_RUNTIME_LIBRARY.html)
 
 project(libCZI 
-      VERSION 0.53.2
+      VERSION 0.54.0
       HOMEPAGE_URL "https://github.com/ZEISS/libczi"
       DESCRIPTION "libCZI is an Open Source Cross-Platform C++ library to read and write CZI")
 

Src/libCZI/libCZI_StreamsLib.h

@@ -15,6 +15,13 @@ namespace libCZI
 {
     class IStream;
 
+    /// A factory object for creating streams objects. 
+    /// libCZI is operating on abstractions (IStream for an input stream, IOutputStream for an output stream and IInputOutputStream
+    /// for and input-output-stream) for accessing the CZI-data. In this class factory we gather implementations provided by libCZI
+    /// and provide functionality to enumerate available classes.
+    /// At this point, we can find two variants here - for operating on a file in a file-system and for operating on an http- or
+    /// https-stream.
+    /// The http-stream class is based on cURL (https://curl.se/libcurl/), and it needs to be configured in when building libCZI.
     class StreamsFactory
     {
     public:
@@ -193,6 +200,7 @@ namespace libCZI
             }
         };
 
+        /// Here the keys for the property-bag with options for creating a stream-object are gathered.
         class StreamProperties
         {
         public:
@@ -217,6 +225,7 @@ namespace libCZI
             };
         };
 
+        /// The parameters for creating an instance of a stream object.
         struct CreateStreamInfo
         {
             std::string class_name;