diff --git a/lib/cmp_chunk.h b/lib/cmp_chunk.h index 93e1ce88366dc309abb781e4a9226e2ad1dce9cc..ea305e52a31a48eaee146a4ba7bf6a1d469c6fb3 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 122cd6814e19967b9649cf783403a9c19bbd124b..bba86c89ddf92ea9191cc6f37b004ec8f8a4d19d 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 5ce8e224a44619f677a4b202e5689748a2c6cc3b..5a1fd11323ee37da80d95c7f06c4e252f2d6f45a 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)