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-07	liblzma: Very minor API doc tweaks.	Lasse Collin	1	-3/+3
	Use "member" to refer to struct members as that's the term used by the C standard. Use lzma_options_delta.dist and such in docs so that in Doxygen's HTML output they will link to the doc of the struct member. Clean up a few trailing white spaces too.
2023-03-07	liblzma: Rename field => member in documentation.	Jia Tan	1	-6/+6
	Also adjusted preset value => preset level.
2023-02-15	liblzma: Add comments for macros in delta.h.	Jia Tan	1	-0/+8
	Document LZMA_DELTA_DIST_MIN and LZMA_DELTA_DIST_MAX for completeness and to avoid Doxygen warnings.
2023-02-03	liblzma: Set documentation on all reserved fields to private.	Jia Tan	1	-0/+12
	This prevents the reserved fields from being part of the generated Doxygen documentation.
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.
2009-04-13	Put the interesting parts of XZ Utils into the public domain.	Lasse Collin	1	-11/+7
	Some minor documentation cleanups were made at the same time.
2008-12-15	Bunch of liblzma API cleanups and fixes.	Lasse Collin	1	-6/+6

2008-09-27	Some API changes, bug fixes, cleanups etc.	Lasse Collin	1	-3/+5

2008-08-28	Sort of garbage collection commit. :-\| Many things are still	Lasse Collin	1	-3/+33
	broken. API has changed a lot and it will still change a little more here and there. The command line tool doesn't have all the required changes to reflect the API changes, so it's easy to get "internal error" or trigger assertions.