d6
/
xz-analysis-mirror
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Jia Tan 2023-03-16 21:38:32 +08:00
parent d42977c7ac
commit 7e2fa48bb7
15 changed files with 2 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/liblzma/api/lzma.h
View File

@ -1,6 +1,7 @@
/** /**
* \file api/lzma.h * \file api/lzma.h
* \brief The public API of liblzma data compression library * \brief The public API of liblzma data compression library
* \mainpage
* *
* liblzma is a public domain general-purpose data compression library with * liblzma is a public domain general-purpose data compression library with
* a zlib-like API. The native file format is .xz, but also the old .lzma * a zlib-like API. The native file format is .xz, but also the old .lzma

2
src/liblzma/api/lzma/base.h
View File

@ -2,8 +2,6 @@
* \file lzma/base.h * \file lzma/base.h
* \brief Data types and functions used in many places in liblzma API * \brief Data types and functions used in many places in liblzma API
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/bcj.h
View File

@ -2,8 +2,6 @@
* \file lzma/bcj.h * \file lzma/bcj.h
* \brief Branch/Call/Jump conversion filters * \brief Branch/Call/Jump conversion filters
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/block.h
View File

@ -2,8 +2,6 @@
* \file lzma/block.h * \file lzma/block.h
* \brief .xz Block handling * \brief .xz Block handling
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/check.h
View File

@ -2,8 +2,6 @@
* \file lzma/check.h * \file lzma/check.h
* \brief Integrity checks * \brief Integrity checks
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/container.h
View File

@ -2,8 +2,6 @@
* \file lzma/container.h * \file lzma/container.h
* \brief File formats * \brief File formats
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/delta.h
View File

@ -2,8 +2,6 @@
* \file lzma/delta.h * \file lzma/delta.h
* \brief Delta filter * \brief Delta filter
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/filter.h
View File

@ -2,8 +2,6 @@
* \file lzma/filter.h * \file lzma/filter.h
* \brief Common filter related types and functions * \brief Common filter related types and functions
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/hardware.h
View File

@ -3,8 +3,6 @@
* \brief Hardware information * \brief Hardware information
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
* *
* See ../lzma.h for information about liblzma as a whole.
*
* Since liblzma can consume a lot of system resources, it also provides * Since liblzma can consume a lot of system resources, it also provides
* ways to limit the resource usage. Applications linking against liblzma * ways to limit the resource usage. Applications linking against liblzma
* need to do the actual decisions how much resources to let liblzma to use. * need to do the actual decisions how much resources to let liblzma to use.

2
src/liblzma/api/lzma/index.h
View File

@ -2,8 +2,6 @@
* \file lzma/index.h * \file lzma/index.h
* \brief Handling of .xz Index and related information * \brief Handling of .xz Index and related information
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/index_hash.h
View File

@ -3,8 +3,6 @@
* \brief Validate Index by using a hash function * \brief Validate Index by using a hash function
* \note Never include this file directly. Use <lzma.h> instead. * \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 * Hashing makes it possible to use constant amount of memory to validate
* Index of arbitrary size. * Index of arbitrary size.
*/ */

2
src/liblzma/api/lzma/lzma12.h
View File

@ -2,8 +2,6 @@
* \file lzma/lzma12.h * \file lzma/lzma12.h
* \brief LZMA1 and LZMA2 filters * \brief LZMA1 and LZMA2 filters
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/stream_flags.h
View File

@ -2,8 +2,6 @@
* \file lzma/stream_flags.h * \file lzma/stream_flags.h
* \brief .xz Stream Header and Stream Footer encoder and decoder * \brief .xz Stream Header and Stream Footer encoder and decoder
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/version.h
View File

@ -2,8 +2,6 @@
* \file lzma/version.h * \file lzma/version.h
* \brief Version number * \brief Version number
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*

2
src/liblzma/api/lzma/vli.h
View File

@ -3,8 +3,6 @@
* \brief Variable-length integer handling * \brief Variable-length integer handling
* \note Never include this file directly. Use <lzma.h> instead. * \note Never include this file directly. Use <lzma.h> instead.
* *
* See ../lzma.h for information about liblzma as a whole.
*
* In the .xz format, most integers are encoded in a variable-length * In the .xz format, most integers are encoded in a variable-length
* representation, which is sometimes called little endian base-128 encoding. * representation, which is sometimes called little endian base-128 encoding.
* This saves space when smaller values are more likely than bigger values. * This saves space when smaller values are more likely than bigger values.