From 142e670a413a7bce1a2647f1cf1f33f8ee2dbe88 Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Mon, 13 May 2024 17:15:04 +0300 Subject: [PATCH] xz: Document the static function get_chains_memusage() --- src/xz/coder.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/xz/coder.c b/src/xz/coder.c index 2cf781ee..5e41f0df 100644 --- a/src/xz/coder.c +++ b/src/xz/coder.c @@ -231,8 +231,18 @@ memlimit_too_small(uint64_t memory_usage) #ifdef HAVE_ENCODERS -// Calculate the memory usage of each filter chain. -// Return the maximum memory usage of all of the filter chains. +/// \brief Calculate the memory usage of each filter chain. +/// +/// \param chains_memusages If non-NULL, the memusage of the encoder +/// or decoder for each chain is stored in +/// this array. +/// \param mt If non-NULL, calculate memory usage of +/// multithreaded encoder. +/// \param encode Whether to calculate encoder or decoder +/// memory usage. This must be true if +/// mt != NULL. +/// +/// \return Return the highest memory usage of all of the filter chains. static uint64_t get_chains_memusage(uint64_t *chains_memusages, const lzma_mt *mt, bool encode) {