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/stream_flags.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 '')
| -rw-r--r-- | src/liblzma/api/lzma/stream_flags.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/liblzma/api/lzma/stream_flags.h b/src/liblzma/api/lzma/stream_flags.h index e259b085..253706e2 100644 --- a/src/liblzma/api/lzma/stream_flags.h +++ b/src/liblzma/api/lzma/stream_flags.h @@ -37,7 +37,7 @@ typedef struct { * * To prevent API and ABI breakages if new features are needed in * Stream Header or Stream Footer, a version number is used to - * indicate which fields in this structure are in use. For now, + * indicate which members in this structure are in use. For now, * version must always be zero. With non-zero version, the * lzma_stream_header_encode() and lzma_stream_footer_encode() * will return LZMA_OPTIONS_ERROR. @@ -70,12 +70,12 @@ typedef struct { lzma_vli backward_size; /** - * \brief Minimum size of the backward_size member + * \brief Minimum value for lzma_stream_flags.backward_size */ # define LZMA_BACKWARD_SIZE_MIN 4 /** - * \brief Maximum size of the backward_size member + * \brief Maximum value for lzma_stream_flags.backward_size */ # define LZMA_BACKWARD_SIZE_MAX (LZMA_VLI_C(1) << 34) |