aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/vli.h
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-03-16 21:38:32 +0800
committerJia Tan <jiat0218@gmail.com>2023-03-17 20:18:52 +0800
commit7e2fa48bb73edb25457232e2e62a4f81c6b95281 (patch)
treeb3456f4c73e37deb544ed10f961e40ac065eba07 /src/liblzma/api/lzma/vli.h
parentBuild: Generate doxygen documentation in autogen.sh. (diff)
downloadxz-7e2fa48bb73edb25457232e2e62a4f81c6b95281.tar.xz
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.
Diffstat (limited to 'src/liblzma/api/lzma/vli.h')
-rw-r--r--src/liblzma/api/lzma/vli.h2
1 files changed, 0 insertions, 2 deletions
diff --git a/src/liblzma/api/lzma/vli.h b/src/liblzma/api/lzma/vli.h
index 097801a4..f9ad1550 100644
--- a/src/liblzma/api/lzma/vli.h
+++ b/src/liblzma/api/lzma/vli.h
@@ -3,8 +3,6 @@
* \brief Variable-length integer handling
* \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
* representation, which is sometimes called little endian base-128 encoding.
* This saves space when smaller values are more likely than bigger values.