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/hardware.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/hardware.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/hardware.h b/src/liblzma/api/lzma/hardware.h index 7040aae4..974f210c 100644 --- a/src/liblzma/api/lzma/hardware.h +++ b/src/liblzma/api/lzma/hardware.h @@ -1,6 +1,9 @@ /** * \file lzma/hardware.h * \brief Hardware information + * \note Never include this file directly. Use <lzma.h> instead. + * + * See ../lzma.h for information about liblzma as a whole. * * Since liblzma can consume a lot of system resources, it also provides * ways to limit the resource usage. Applications linking against liblzma @@ -25,8 +28,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 |