small changes?

y-scope · Jan 29, 2025 · d3a52d4 · d3a52d4
1 parent a6974c7
commit d3a52d4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp b/components/core/src/clp/streaming_archive/ArchiveMetadata.cpp
@@ -27,7 +27,7 @@ ArchiveMetadata::ArchiveMetadata(
 }
 
 auto ArchiveMetadata::create_from_file_reader(FileReader& file_reader) -> ArchiveMetadata {
-    struct stat file_stat = {};
+    struct stat file_stat{};
     auto clp_rc = file_reader.try_fstat(file_stat);
     if (clp::ErrorCode::ErrorCode_Success != clp_rc) {
         throw OperationFailed(ErrorCode_Failure, __FILENAME__, __LINE__);

diff --git a/components/core/src/clp/streaming_archive/ArchiveMetadata.hpp b/components/core/src/clp/streaming_archive/ArchiveMetadata.hpp
@@ -48,14 +48,14 @@ class ArchiveMetadata {
 
     // Methods
     /**
-     * Reads serialized MessagePack data from `file_reader`, then unpacks it into an
+     * Reads serialized MessagePack data from open file, unpacks it into an
      * `ArchiveMetadata` instance.
      *
      * @param file_reader Reader for the file containing archive metadata.
      * @return The created instance.
-     * @throw `ArchiveMetadata::OperationFailed` if stat or read for metadata file fails.
-     * @throw `msgpack::unpack_error` if data cannot be deserialized into MessagePack format.
-     * @throw `msgpack::type_error` if deserialized MessagePack data can't be converted to
+     * @throw `ArchiveMetadata::OperationFailed` if stat or read operation on metadata file fails.
+     * @throw `msgpack::unpack_error` if data cannot be unpacked into MessagePack object.
+     * @throw `msgpack::type_error` if MessagePack object can't be converted to
      * `ArchiveMetadata`.
      */
     [[nodiscard]] static auto create_from_file_reader(FileReader& file_reader) -> ArchiveMetadata;
@@ -112,7 +112,7 @@ class ArchiveMetadata {
     void expand_time_range(epochtime_t begin_timestamp, epochtime_t end_timestamp);
 
     /**
-     * Serializes `ArchiveMetadata` instance to MessagePack and writes to `file_writer`.
+     * Packs `ArchiveMetadata` to MessagePack and writes to open file.
      *
      * @param file_writer Writer for archive metadata file.
      * @throw FileWriter::OperationFailed if failed to write.