aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/index_hash.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/index_hash.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/index_hash.h')
-rw-r--r--src/liblzma/api/lzma/index_hash.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/index_hash.h b/src/liblzma/api/lzma/index_hash.h
index 8ff41633..bb5054b0 100644
--- a/src/liblzma/api/lzma/index_hash.h
+++ b/src/liblzma/api/lzma/index_hash.h
@@ -1,6 +1,9 @@
/**
* \file lzma/index_hash.h
* \brief Validate Index by using a hash function
+ * \note Never include this file directly. Use <lzma.h> instead.
+ *
+ * See ../lzma.h for information about liblzma as a whole.
*
* Hashing makes it possible to use constant amount of memory to validate
* Index of arbitrary size.
@@ -11,8 +14,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