From 8e1fd97d16988cb1a894ed46e21493530ee1ddcc Mon Sep 17 00:00:00 2001 From: Przemyslaw Skibinski Date: Mon, 23 Jan 2017 17:46:32 +0100 Subject: lz4frame.h: added Introduction --- lib/lz4frame.h | 9 +++++++++ 1 file changed, 9 insertions(+) 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 /* 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 *****************************************************************/ -- cgit v0.12