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-03-01	liblzma: Clarify lzma_lzma_preset() documentation in lzma12.h.	Jia Tan	1	-0/+5
	lzma_lzma_preset() does not guarentee that the lzma_options_lzma are usable in an encoder even if it returns false (success). If liblzma is built with default configurations, then the options will always be usable. However if the match finders hc3, hc4, or bt4 are disabled, then the options may not be usable depending on the preset level requested. The documentation was updated to reflect this complexity, since this behavior was unclear before.
2023-02-17	liblzma: Rename field => member in documentation.	Jia Tan	1	-14/+14
	Also adjusted preset value => preset level.
2023-02-15	liblzma: Improve documentation in lzma12.h.	Jia Tan	1	-9/+23
	All functions now explicitly specify parameter and return values.
2023-01-21	liblzma: Set documentation on all reserved fields to private.	Jia Tan	1	-0/+22
	This prevents the reserved fields from being part of the generated Doxygen documentation.
2023-01-20	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-27	liblzma: Add LZMA_FILTER_LZMA1EXT to support LZMA1 without end marker.	Lasse Collin	1	-7/+116
	Some file formats need support for LZMA1 streams that don't use the end of payload marker (EOPM) alias end of stream (EOS) marker. So far liblzma API has supported decompressing such streams via lzma_alone_decoder() when .lzma header specifies a known uncompressed size. Encoding support hasn't been available in the API. Instead of adding a new LZMA1-only API for this purpose, this commit adds a new filter ID for use with raw encoder and decoder. The main benefit of this approach is that then also filter chains are possible, for example, if someone wants to implement support for .7z files that use the x86 BCJ filter with LZMA1 (not BCJ2 as that isn't supported in liblzma).
2019-05-11	spelling	Antoine Cœur	1	-1/+1

2014-05-04	liblzma: Rename the private API header lzma/lzma.h to lzma/lzma12.h.	Lasse Collin	1	-0/+420
	It can be confusing that two header files have the same name. The public API file is still lzma.h.