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/lzma12.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/lzma12.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/lzma12.h b/src/liblzma/api/lzma/lzma12.h index d34e7839..1b1ba2b3 100644 --- a/src/liblzma/api/lzma/lzma12.h +++ b/src/liblzma/api/lzma/lzma12.h @@ -1,6 +1,9 @@ /** * \file lzma/lzma12.h * \brief LZMA1 and LZMA2 filters + * \note Never include this file directly. Use <lzma.h> instead. + * + * See ../lzma.h for information about liblzma as a whole. */ /* @@ -8,8 +11,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 |