xz.git - XZ Utils

Age	Commit message (Collapse)	Author	Files	Lines
2023-03-17	liblzma: Add set lzma.h as the main page for Doxygen documentation.	Jia Tan	1	-2/+0
	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.
2023-02-03	liblzma: Highlight liblzma API headers should not be included directly.	Jia Tan	1	-2/+3
	This improves the generated Doxygen HTML files to better highlight how to properly use the liblzma API header files.
2022-11-21	liblzma: Fix two Doxygen commands in the API headers.	Lasse Collin	1	-1/+1
	These were caught by clang -Wdocumentation.
2019-05-11	spelling	Antoine Cœur	1	-1/+1

2014-06-18	liblzma: Add lzma_cputhreads().	Lasse Collin	1	-0/+14

2010-10-21	liblzma: Update the comments in the API headers.	Lasse Collin	1	-2/+1
	Adding support for LZMA_FINISH for Index encoding and decoding needed tiny additions to the relevant .c files too.
2009-11-15	Add lzma_physmem().	Lasse Collin	1	-0/+51
	I had hoped to keep liblzma as purely a compression library as possible (e.g. file I/O will go into a different library), but it seems that applications linking agaisnt liblzma need some way to determine the memory usage limit, and knowing the amount of RAM is one reasonable way to help making such decisions. Thanks to Jonathan Nieder for the original patch.