diff options
| author | Yann Collet <cyan@fb.com> | 2016-11-21 22:13:00 (GMT) |
|---|---|---|
| committer | Yann Collet <cyan@fb.com> | 2016-11-21 22:13:00 (GMT) |
| commit | 742f2b683e948d837aff607a2cfff6f67b039f54 (patch) | |
| tree | 45f9780c49cca3f223e86578c1e82b62f9e70ad0 | |
| parent | 2dbcebfdac45351abdbbd78c56898691bb6147db (diff) | |
| download | lz4-742f2b683e948d837aff607a2cfff6f67b039f54.zip lz4-742f2b683e948d837aff607a2cfff6f67b039f54.tar.gz lz4-742f2b683e948d837aff607a2cfff6f67b039f54.tar.bz2 | |
added doc in code comments
| -rw-r--r-- | lib/lz4frame.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h index e26be76..9449e0d 100644 --- a/lib/lz4frame.h +++ b/lib/lz4frame.h @@ -130,6 +130,10 @@ typedef LZ4F_frameType_t frameType_t; typedef LZ4F_contentChecksum_t contentChecksum_t; #endif +/* LZ4F_frameInfo_t : + * makes it possible to supply detailed frame parameters to the stream interface. + * It's not required to set all fields, as long as the structure was initially memset() to zero. + * All reserved fields must be set to zero. */ typedef struct { LZ4F_blockSizeID_t blockSizeID; /* max64KB, max256KB, max1MB, max4MB ; 0 == default */ LZ4F_blockMode_t blockMode; /* blockLinked, blockIndependent ; 0 == default */ @@ -139,6 +143,10 @@ typedef struct { unsigned reserved[2]; /* must be zero for forward compatibility */ } LZ4F_frameInfo_t; +/* LZ4F_preferences_t : + * makes it possible to supply detailed compression parameters to the stream interface. + * It's not required to set all fields, as long as the structure was initially memset() to zero. + * All reserved fields must be set to zero. */ typedef struct { LZ4F_frameInfo_t frameInfo; int compressionLevel; /* 0 == default (fast mode); values above 16 count as 16; values below 0 count as 0 */ |