diff options
| author | Lasse Collin <lasse.collin@tukaani.org> | 2023-02-16 21:09:00 +0200 |
|---|---|---|
| committer | Lasse Collin <lasse.collin@tukaani.org> | 2023-02-16 21:09:00 +0200 |
| commit | d831072cceca458d94d2d5da201862f6d43a417b (patch) | |
| tree | 6a165db05825682d5c58f2b8ff1bc3a10b87b5d4 /src/liblzma/api/lzma/block.h | |
| parent | liblzma: Adjust spacing in doc headers in bcj.h. (diff) | |
| download | xz-d831072cceca458d94d2d5da201862f6d43a417b.tar.xz | |
liblzma: Very minor API doc tweaks.
Use "member" to refer to struct members as that's the term used
by the C standard.
Use lzma_options_delta.dist and such in docs so that in Doxygen's
HTML output they will link to the doc of the struct member.
Clean up a few trailing white spaces too.
Diffstat (limited to 'src/liblzma/api/lzma/block.h')
| -rw-r--r-- | src/liblzma/api/lzma/block.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/liblzma/api/lzma/block.h b/src/liblzma/api/lzma/block.h index 7080301f..f556ce34 100644 --- a/src/liblzma/api/lzma/block.h +++ b/src/liblzma/api/lzma/block.h @@ -33,11 +33,11 @@ typedef struct { * \brief Block format version * * To prevent API and ABI breakages when new features are needed, - * a version number is used to indicate which fields in this + * a version number is used to indicate which members in this * structure are in use: * - liblzma >= 5.0.0: version = 0 is supported. * - liblzma >= 5.1.4beta: Support for version = 1 was added, - * which adds the ignore_check field. + * which adds the ignore_check member. * * If version is greater than one, most Block related functions * will return LZMA_OPTIONS_ERROR (lzma_block_header_decode() works @@ -286,7 +286,7 @@ typedef struct { /** * \brief A flag to Block decoder to not verify the Check field * - * This field is supported by liblzma >= 5.1.4beta if .version >= 1. + * This member is supported by liblzma >= 5.1.4beta if .version >= 1. * * If this is set to true, the integrity check won't be calculated * and verified. Unless you know what you are doing, you should |