]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
Doxygen: Fix errors and some warnings in internal docs
authorLasse Collin <lasse.collin@tukaani.org>
Tue, 22 Apr 2025 13:21:50 +0000 (16:21 +0300)
committerLasse Collin <lasse.collin@tukaani.org>
Tue, 22 Apr 2025 16:00:19 +0000 (19:00 +0300)
src/liblzma/check/crc32_fast.c
src/liblzma/check/crc64_fast.c
src/liblzma/common/outqueue.h
src/xz/list.c
src/xz/message.h

index 3c7cb95f57b7fcac10741ff8fe03a2a158cb8fa8..6184e2b70e6ba6515158f26970eec8025d69ae05 100644 (file)
@@ -2,7 +2,7 @@
 
 ///////////////////////////////////////////////////////////////////////////////
 //
-/// \file       crc32.c
+/// \file       crc32_fast.c
 /// \brief      CRC32 calculation
 //
 //  Authors:    Lasse Collin
index e382bc7e8c6501836f35ae827fd19cfed687de55..792d0f9488bd261eaba2a5b7f5f95ddd67764dc7 100644 (file)
@@ -2,7 +2,7 @@
 
 ///////////////////////////////////////////////////////////////////////////////
 //
-/// \file       crc64.c
+/// \file       crc64_fast.c
 /// \brief      CRC64 calculation
 //
 //  Authors:    Lasse Collin
index 25f071977a8f3724a95b11da0c3541e3c86a2756..0e4e9141dab55947aabae99e476336d3a247cabb 100644 (file)
@@ -188,6 +188,7 @@ extern bool lzma_outq_is_readable(const lzma_outq *outq);
 /// \brief      Read finished data
 ///
 /// \param      outq            Pointer to an output queue
+/// \param      allocator       lzma_allocator for custom allocator functions
 /// \param      out             Beginning of the output buffer
 /// \param      out_pos         The next byte will be written to
 ///                             out[*out_pos].
index 6a71d01e437ecb89c04d7fbe7179a132c931ed97..210f23ad1baa5b81e979ed362abf7ca919749b39 100644 (file)
@@ -655,6 +655,8 @@ parse_check_value(file_pair *pair, const lzma_index_iter *iter)
 ///                     be printed.
 /// \param      bhi     Pointer to structure where to store the information
 ///                     about the Block Header field.
+/// \param      xfi     Pointer to structure where to store the information
+///                     about the entire .xz file.
 ///
 /// \return     False on success, true on error. If an error occurs,
 ///             the error message is printed too so the caller doesn't
index 3f6e183585f70a01ae7e926c176e9aabfbbcc952..5f0af7f7e8a5225fff964c731f2dbc58b55a6e88 100644 (file)
@@ -144,6 +144,10 @@ extern void message_filename(const char *src_name);
 /// given *strm becomes invalid.
 ///
 /// \param      strm      Pointer to lzma_stream used for the coding.
+/// \param      is_passthru
+///                       If true, we are copying input to output without
+///                       encoding or decoding, and thus cannot use
+///                       lzma_get_progress().
 /// \param      in_size   Size of the input file, or zero if unknown.
 ///
 extern void message_progress_start(lzma_stream *strm,