From 6fcf4671b6047113c583a0919fc850987a4ec5f4 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/base.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'src/liblzma/api/lzma/base.h') 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 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 -- cgit v1.2.3