aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/delta.h
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2023-02-16 21:09:00 +0200
committerJia Tan <jiat0218@gmail.com>2023-03-07 23:23:19 +0800
commitbc34e5ac9996667d2c1ec9a7895ec5931ac4caea (patch)
treef23e82886a50ea59d457b6d334e6aa735d9db324 /src/liblzma/api/lzma/delta.h
parentliblzma: Adjust spacing in doc headers in bcj.h. (diff)
downloadxz-bc34e5ac9996667d2c1ec9a7895ec5931ac4caea.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/delta.h')
-rw-r--r--src/liblzma/api/lzma/delta.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/liblzma/api/lzma/delta.h b/src/liblzma/api/lzma/delta.h
index ad1aca90..3d7a7f02 100644
--- a/src/liblzma/api/lzma/delta.h
+++ b/src/liblzma/api/lzma/delta.h
@@ -60,12 +60,12 @@ typedef struct {
uint32_t dist;
/**
- * \brief Minimum value for the dist field in lzma_options_delta.
+ * \brief Minimum value for lzma_options_delta.dist.
*/
# define LZMA_DELTA_DIST_MIN 1
- /**
- * \brief Maximum value for the dist field in lzma_options_delta.
+ /**
+ * \brief Maximum value for lzma_options_delta.dist.
*/
# define LZMA_DELTA_DIST_MAX 256