diff options
| author | Jia Tan <jiat0218@gmail.com> | 2022-12-21 23:59:43 +0800 |
|---|---|---|
| committer | Jia Tan <jiat0218@gmail.com> | 2023-02-03 21:38:26 +0800 |
| commit | bd213d06ebf92cf42eeb97e7c578bddc857f8ea8 (patch) | |
| tree | fd16d31671bbf2a3d1b2c998ad01a1970d681959 /src/liblzma/api/lzma/base.h | |
| parent | tuklib_physmem: Silence warning from -Wcast-function-type on MinGW-w64. (diff) | |
| download | xz-bd213d06ebf92cf42eeb97e7c578bddc857f8ea8.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/base.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/base.h b/src/liblzma/api/lzma/base.h index ff2d8696..5e44ad5e 100644 --- a/src/liblzma/api/lzma/base.h +++ b/src/liblzma/api/lzma/base.h @@ -1,6 +1,9 @@ /** * \file lzma/base.h * \brief Data types and functions used in many places in liblzma API + * \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 |