From ab9db4aa716db0dfdc714994c39619a350d6652a Mon Sep 17 00:00:00 2001
From: Dominik Loidolt <dominik.loidolt@univie.ac.at>
Date: Fri, 8 Mar 2024 15:31:36 +0100
Subject: [PATCH] Fix typos
---
lib/cmp_chunk.h | 3 ++-
lib/common/cmp_data_types.c | 2 +-
lib/icu_compress/cmp_icu.c | 9 +++++----
3 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/lib/cmp_chunk.h b/lib/cmp_chunk.h
index 93e1ce8..ea305e5 100644
--- a/lib/cmp_chunk.h
+++ b/lib/cmp_chunk.h
@@ -149,7 +149,8 @@ void compress_chunk_init(uint64_t(return_timestamp)(void), uint32_t version_id);
* buffer for in-place update or NULL if updated
* model is not needed)
* @param dst destination pointer to the compressed data
- * buffer; has to be 4-byte aligned (can be NULL)
+ * buffer; has to be 4-byte aligned; can be NULL to
+ * only get the compressed data size
* @param dst_capacity capacity of the dst buffer; it's recommended to
* provide a dst_capacity >=
* compress_chunk_cmp_size_bound(chunk, chunk_size)
diff --git a/lib/common/cmp_data_types.c b/lib/common/cmp_data_types.c
index 122cd68..bba86c8 100644
--- a/lib/common/cmp_data_types.c
+++ b/lib/common/cmp_data_types.c
@@ -365,7 +365,7 @@ int cmp_col_set_data_length(struct collection_hdr *col, uint16_t length)
/**
* @brief converts a subservice to its associated compression data type
*
- * @param subservice collection subservice
+ * @param subservice collection subservice type
*
* @returns the converted compression data type; DATA_TYPE_UNKNOWN if the
* subservice is unknown
diff --git a/lib/icu_compress/cmp_icu.c b/lib/icu_compress/cmp_icu.c
index 5ce8e22..5a1fd11 100644
--- a/lib/icu_compress/cmp_icu.c
+++ b/lib/icu_compress/cmp_icu.c
@@ -97,7 +97,7 @@ struct encoder_setupt {
/**
- * @brief types of chunks containing different types of collection
+ * @brief types of chunks containing different types of collections
* according to DetailedBudgetWorking_2023-10-11
*/
@@ -2354,7 +2354,7 @@ static int set_cmp_col_size(uint8_t *cmp_col_size_field, int32_t cmp_col_size)
* @param updated_model pointer to the buffer where the updated model will be
* stored, or NULL if not applicable
* @param dst pointer to the buffer where the compressed data will be
- * stored, or NULL to only get the size
+ * stored, or NULL to only get the compressed data size
* @param dst_capacity the size of the dst buffer in bytes
* @param cfg pointer to a compression configuration
* @param dst_size the already used size of the dst buffer in bytes
@@ -2459,7 +2459,7 @@ static int32_t cmp_collection(uint8_t *col, uint8_t *model, uint8_t *updated_mod
* @brief builds a compressed entity header for a compressed chunk
*
* @param ent start address of the compression entity header
- * (can be NULL if you only wont the entity header
+ * (can be NULL if you only want the entity header
* size)
* @param chunk_size the original size of the chunk in bytes
* @param cfg pointer to the compression configuration used to
@@ -2717,7 +2717,8 @@ void compress_chunk_init(uint64_t(return_timestamp)(void), uint32_t version_id)
* buffer for in-place update or NULL if updated
* model is not needed)
* @param dst destination pointer to the compressed data
- * buffer; has to be 4-byte aligned (can be NULL)
+ * buffer; has to be 4-byte aligned; can be NULL to
+ * only get the compressed data size
* @param dst_capacity capacity of the dst buffer; it's recommended to
* provide a dst_capacity >=
* compress_chunk_cmp_size_bound(chunk, chunk_size)
--
GitLab