diff options
| author | Przemyslaw Skibinski <inikep@gmail.com> | 2017-01-23 16:46:32 (GMT) |
|---|---|---|
| committer | Przemyslaw Skibinski <inikep@gmail.com> | 2017-01-23 16:46:32 (GMT) |
| commit | 8e1fd97d16988cb1a894ed46e21493530ee1ddcc (patch) | |
| tree | 539b37ca9eb911b81c27971e3803e9c1631a1588 /lib/lz4frame.h | |
| parent | d56ee32b394f95e4403ccce4a38fe633e77c752b (diff) | |
| download | lz4-8e1fd97d16988cb1a894ed46e21493530ee1ddcc.zip lz4-8e1fd97d16988cb1a894ed46e21493530ee1ddcc.tar.gz lz4-8e1fd97d16988cb1a894ed46e21493530ee1ddcc.tar.bz2 | |
lz4frame.h: added Introduction
Diffstat (limited to 'lib/lz4frame.h')
| -rw-r--r-- | lib/lz4frame.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h index 02852d4..82fbeab 100644 --- a/lib/lz4frame.h +++ b/lib/lz4frame.h @@ -48,6 +48,15 @@ extern "C" { /* --- Dependency --- */ #include <stddef.h> /* size_t */ + +/** + Introduction + + lz4frame.h implements LZ4 frame specification (doc/lz4_Frame_format.md). + lz4frame.h provides frame compression functions that take care + of encoding standard metadata alongside LZ4-compressed blocks. +*/ + /*^*************************************************************** * Compiler specifics *****************************************************************/ |