root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

liblzma: Reword a few lines in filter.h

This commit is contained in:
Jia Tan 2023-02-06 21:44:45 +08:00
parent 8a53533869
commit 5e61b39432
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/liblzma/api/lzma/filter.h
View File

@ -30,7 +30,7 @@
/** /**
* \brief Filter options * \brief Filter options
* *
* This structure is used to pass Filter ID and a pointer filter's * This structure is used to pass a Filter ID and a pointer to the filter's
* options to liblzma. A few functions work with a single lzma_filter * options to liblzma. A few functions work with a single lzma_filter
* structure, while most functions expect a filter chain. * structure, while most functions expect a filter chain.
* *
@ -38,8 +38,8 @@
* The array is terminated with .id = LZMA_VLI_UNKNOWN. Thus, the filter * The array is terminated with .id = LZMA_VLI_UNKNOWN. Thus, the filter
* array must have LZMA_FILTERS_MAX + 1 elements (that is, five) to * array must have LZMA_FILTERS_MAX + 1 elements (that is, five) to
* be able to hold any arbitrary filter chain. This is important when * be able to hold any arbitrary filter chain. This is important when
* using lzma_block_header_decode() from block.h, because too small * using lzma_block_header_decode() from block.h, because a filter array
* array would make liblzma write past the end of the filters array. * that is too small would make liblzma write past the end of the array.
*/ */
typedef struct { typedef struct {
/** /**
@ -149,8 +149,8 @@ extern LZMA_API(lzma_ret) lzma_filters_copy(
* - options will be set to NULL. * - options will be set to NULL.
* - id will be set to LZMA_VLI_UNKNOWN. * - id will be set to LZMA_VLI_UNKNOWN.
* *
* If filters is NULL, this does nothing but remember that this never frees * If filters is NULL, this does nothing. Again, this never frees the
* the filters array itself. * filters array itself.
* *
* \param filters Array of filters terminated with * \param filters Array of filters terminated with
* .id == LZMA_VLI_UNKNOWN. * .id == LZMA_VLI_UNKNOWN.