root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Cleaned up some comments in the API headers.

This commit is contained in:
Lasse Collin 2008-12-31 17:15:03 +02:00
parent 322ecf93c9
commit 88d3e6b0b1
3 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/liblzma/api/lzma/check.h
View File

@ -63,22 +63,15 @@ typedef enum {
* \brief Maximum valid Check ID * \brief Maximum valid Check ID
* *
* The .xz file format specification specifies 16 Check IDs (0-15). Some * The .xz file format specification specifies 16 Check IDs (0-15). Some
* of them are only reserved i.e. no actual Check algorithm has been assigned. * of them are only reserved, that is, no actual Check algorithm has been
* Still liblzma accepts any of these IDs for future compatibility when * assigned. When decoding, liblzma still accepts unknown Check IDs for
* decoding files. If a valid but unsupported Check ID is detected, liblzma * future compatibility. If a valid but unsupported Check ID is detected,
* indicates a warning with LZMA_UNSUPPORTED_CHECK. * liblzma can indicate a warning; see the flags LZMA_TELL_NO_CHECK,
* * LZMA_TELL_UNSUPPORTED_CHECK, and LZMA_TELL_ANY_CHECK in container.h.
* FIXME bad desc
*/ */
#define LZMA_CHECK_ID_MAX 15 #define LZMA_CHECK_ID_MAX 15
/**
* \brief Maximum size of a Check field
*/
#define LZMA_CHECK_SIZE_MAX 64
/** /**
* \brief Test if the given Check ID is supported * \brief Test if the given Check ID is supported
* *
@ -106,6 +99,12 @@ extern lzma_bool lzma_check_is_supported(lzma_check check)
extern uint32_t lzma_check_size(lzma_check check) lzma_attr_const; extern uint32_t lzma_check_size(lzma_check check) lzma_attr_const;
/**
* \brief Maximum size of a Check field
*/
#define LZMA_CHECK_SIZE_MAX 64
/** /**
* \brief Calculate CRC32 * \brief Calculate CRC32
* *

2
src/liblzma/api/lzma/container.h
View File

@ -76,7 +76,7 @@ extern uint64_t lzma_easy_encoder_memusage(uint32_t preset)
/** /**
* \brief Calculate rough memory usage FIXME * \brief Calculate rough decoder memory usage of a preset
* *
* This function is a wrapper for lzma_raw_decoder_memusage(). * This function is a wrapper for lzma_raw_decoder_memusage().
* *

4
src/liblzma/api/lzma/version.h
View File

@ -30,7 +30,9 @@
* - zzz = revision * - zzz = revision
* - s indicates stability: 0 = alpha, 1 = beta, 2 = stable * - s indicates stability: 0 = alpha, 1 = beta, 2 = stable
* *
* See the README file for details about the version numbering. FIXME * The same xyyyzzz triplet is never reused with different stability levels.
* For example, if 5.1.0alpha has been released, there will never be 5.1.0beta
* or 5.1.0 stable.
* *
* \note The version number of liblzma has nothing to with * \note The version number of liblzma has nothing to with
* the version number of Igor Pavlov's LZMA SDK. * the version number of Igor Pavlov's LZMA SDK.