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/index_hash.h | 4 +--- 1 file changed, 1 insertion(+), 3 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 5780ab3a..a2d4c484 100644 --- a/src/liblzma/api/lzma/index_hash.h +++ b/src/liblzma/api/lzma/index_hash.h @@ -3,8 +3,6 @@ * \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. */ @@ -118,7 +116,7 @@ extern LZMA_API(lzma_ret) lzma_index_hash_decode(lzma_index_hash *index_hash, * This is needed to verify the Backward Size field in the Stream Footer. * * \param index_hash Pointer to a lzma_index_hash structure - * + * * \return Size of the Index field in bytes. */ extern LZMA_API(lzma_vli) lzma_index_hash_size( -- cgit v1.2.3