From 55ba6e93004842ae0a0792214a23504267ad8f43 Mon Sep 17 00:00:00 2001 From: Jia Tan Date: Thu, 16 Mar 2023 21:38:32 +0800 Subject: liblzma: Add set lzma.h as the main page for Doxygen documentation. The \mainpage command is used in the first block of comments in lzma.h. This changes the previously nearly empty index.html to use the first comment block in lzma.h for its contents. lzma.h is no longer documented separately, but this is for the better since lzma.h only defined a few macros that users do not need to use. The individual API header files all have a disclaimer that they should not be #included directly, so there should be no confusion on the fact that lzma.h should be the only header used by applications. Additionally, the note "See ../lzma.h for information about liblzma as a whole." was removed since lzma.h is now the main page of the generated HTML and does not have its own page anymore. So it would be confusing in the HTML version and was only a "nice to have" when browsing the source files. --- src/liblzma/api/lzma/container.h | 2 -- 1 file changed, 2 deletions(-) (limited to 'src/liblzma/api/lzma/container.h') diff --git a/src/liblzma/api/lzma/container.h b/src/liblzma/api/lzma/container.h index 33fccf90..48a64365 100644 --- a/src/liblzma/api/lzma/container.h +++ b/src/liblzma/api/lzma/container.h @@ -2,8 +2,6 @@ * \file lzma/container.h * \brief File formats * \note Never include this file directly. Use instead. - * - * See ../lzma.h for information about liblzma as a whole. */ /* -- cgit v1.2.3