summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Drake <tlsa@netsurf-browser.org>2021-04-04 22:26:11 +0100
committerMichael Drake <tlsa@netsurf-browser.org>2021-04-04 22:26:11 +0100
commitc8f094505a7d53997ef8f8b2d05fc114eee9315b (patch)
tree702bb67fbc93c1b8bf5a5f44ffc44f001c27b908
parent3f760807f71ffef44a6ac36d0eb0c09c65ad90ba (diff)
downloadlibnsgif-c8f094505a7d53997ef8f8b2d05fc114eee9315b.tar.gz
libnsgif-c8f094505a7d53997ef8f8b2d05fc114eee9315b.tar.bz2
f
-rw-r--r--src/lzw.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/src/lzw.h b/src/lzw.h
index 2e82869..4b6bfab 100644
--- a/src/lzw.h
+++ b/src/lzw.h
@@ -77,15 +77,14 @@ lzw_result lzw_decode_init(
uint8_t minimum_code_size);
/**
- * Fill the LZW stack with decompressed data
+ * Read a single LZW code into the output buffer.
*
* Ensure anything on the stack is used before calling this, as anything
* on the stack before this call will be trampled.
*
- * \param[in] ctx LZW reading context, updated.
- * \param[out] written Returns the number of values written.
- * Use with `stack_base_out` value from previous
- * lzw_decode_init() call.
+ * \param[in] ctx LZW reading context, updated.
+ * \param[out] data Returns pointer to array of output values.
+ * \param[out] used Returns the number of values written to data.
* \return LZW_OK on success, or appropriate error code otherwise.
*/
lzw_result lzw_decode(struct lzw_ctx *ctx,