From bd213d06ebf92cf42eeb97e7c578bddc857f8ea8 Mon Sep 17 00:00:00 2001 From: Jia Tan Date: Wed, 21 Dec 2022 23:59:43 +0800 Subject: 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. --- src/liblzma/api/lzma/index_hash.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'src/liblzma/api/lzma/index_hash.h') 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 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 -- cgit v1.2.3