diff options
| author | Jia Tan <jiat0218@gmail.com> | 2023-03-16 21:38:32 +0800 |
|---|---|---|
| committer | Jia Tan <jiat0218@gmail.com> | 2023-03-17 01:42:28 +0800 |
| commit | 55ba6e93004842ae0a0792214a23504267ad8f43 (patch) | |
| tree | 12824218fddc603c7eb652de723ce49aa5439989 /src/liblzma/api/lzma.h | |
| parent | Build: Generate doxygen documentation in autogen.sh. (diff) | |
| download | xz-55ba6e93004842ae0a0792214a23504267ad8f43.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.h')
| -rw-r--r-- | src/liblzma/api/lzma.h | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/src/liblzma/api/lzma.h b/src/liblzma/api/lzma.h index 8fbd9a87..ba4abd8c 100644 --- a/src/liblzma/api/lzma.h +++ b/src/liblzma/api/lzma.h @@ -1,6 +1,7 @@ /** * \file api/lzma.h * \brief The public API of liblzma data compression library + * \mainpage * * 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 |