]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
liblzma: Fix API docs to mention LZMA_UNSUPPORTED_CHECK.
authorLasse Collin <lasse.collin@tukaani.org>
Mon, 11 Apr 2011 10:28:40 +0000 (13:28 +0300)
committerLasse Collin <lasse.collin@tukaani.org>
Mon, 11 Apr 2011 11:00:50 +0000 (14:00 +0300)
This return value was missing from the API comments of
four functions.

src/liblzma/api/lzma/block.h
src/liblzma/api/lzma/container.h

index 3019bf916fecf6d56a2b19e8b5c6e40824ade47f..8a4bf2323cccde507a1aabafa04d188921f2b513 100644 (file)
@@ -483,6 +483,7 @@ extern LZMA_API(size_t) lzma_block_buffer_bound(size_t uncompressed_size)
  *
  * \return      - LZMA_OK: Encoding was successful.
  *              - LZMA_BUF_ERROR: Not enough output buffer space.
+ *              - LZMA_UNSUPPORTED_CHECK
  *              - LZMA_OPTIONS_ERROR
  *              - LZMA_MEM_ERROR
  *              - LZMA_DATA_ERROR
index 83e70b44f220f1050146e6190e745dbdcd145bde..56ef774cb2f2f703d6f485d6b478950d5c1db365 100644 (file)
@@ -148,6 +148,7 @@ extern LZMA_API(lzma_ret) lzma_easy_encoder(
  *
  * \return      - LZMA_OK: Encoding was successful.
  *              - LZMA_BUF_ERROR: Not enough output buffer space.
+ *              - LZMA_UNSUPPORTED_CHECK
  *              - LZMA_OPTIONS_ERROR
  *              - LZMA_MEM_ERROR
  *              - LZMA_DATA_ERROR
@@ -171,6 +172,7 @@ extern LZMA_API(lzma_ret) lzma_easy_buffer_encode(
  *
  * \return      - LZMA_OK: Initialization was successful.
  *              - LZMA_MEM_ERROR
+ *              - LZMA_UNSUPPORTED_CHECK
  *              - LZMA_OPTIONS_ERROR
  *              - LZMA_PROG_ERROR
  */
@@ -250,6 +252,7 @@ extern LZMA_API(size_t) lzma_stream_buffer_bound(size_t uncompressed_size)
  *
  * \return      - LZMA_OK: Encoding was successful.
  *              - LZMA_BUF_ERROR: Not enough output buffer space.
+ *              - LZMA_UNSUPPORTED_CHECK
  *              - LZMA_OPTIONS_ERROR
  *              - LZMA_MEM_ERROR
  *              - LZMA_DATA_ERROR