aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/check.h
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2022-12-21 23:59:43 +0800
committerJia Tan <jiat0218@gmail.com>2023-02-03 21:38:26 +0800
commitbd213d06ebf92cf42eeb97e7c578bddc857f8ea8 (patch)
treefd16d31671bbf2a3d1b2c998ad01a1970d681959 /src/liblzma/api/lzma/check.h
parenttuklib_physmem: Silence warning from -Wcast-function-type on MinGW-w64. (diff)
downloadxz-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 'src/liblzma/api/lzma/check.h')
-rw-r--r--src/liblzma/api/lzma/check.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/check.h b/src/liblzma/api/lzma/check.h
index 6a243db0..c7336ae5 100644
--- a/src/liblzma/api/lzma/check.h
+++ b/src/liblzma/api/lzma/check.h
@@ -1,6 +1,9 @@
/**
* \file lzma/check.h
* \brief Integrity checks
+ * \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