diff options
| author | Jia Tan <jiat0218@gmail.com> | 2022-12-21 23:59:43 +0800 |
|---|---|---|
| committer | Jia Tan <jiat0218@gmail.com> | 2023-01-20 00:51:12 +0800 |
| commit | 6fcf4671b6047113c583a0919fc850987a4ec5f4 (patch) | |
| tree | 47fc755df1233362ddb9094396814ca0de073198 /src/liblzma/api/lzma/vli.h | |
| parent | tuklib_physmem: Silence warning from -Wcast-function-type on MinGW-w64. (diff) | |
| download | xz-6fcf4671b6047113c583a0919fc850987a4ec5f4.tar.xz | |
liblzma: Highlight liblzma API headers should not be included directly.
This improves the generated Doxygen HTML files to better highlight
how to properly use the liblzma API header files.
Diffstat (limited to '')
| -rw-r--r-- | src/liblzma/api/lzma/vli.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/vli.h b/src/liblzma/api/lzma/vli.h index 7a0a803d..6b604392 100644 --- a/src/liblzma/api/lzma/vli.h +++ b/src/liblzma/api/lzma/vli.h @@ -1,6 +1,9 @@ /** * \file lzma/vli.h * \brief Variable-length integer handling + * \note Never include this file directly. Use <lzma.h> instead. + * + * See ../lzma.h for information about liblzma as a whole. * * In the .xz format, most integers are encoded in a variable-length * representation, which is sometimes called little endian base-128 encoding. @@ -19,8 +22,6 @@ * * This file has been put into the public domain. * You can do whatever you want with this file. - * - * See ../lzma.h for information about liblzma as a whole. */ #ifndef LZMA_H_INTERNAL |