diff options
Diffstat (limited to 'docs/decode.h.3')
| -rwxr-xr-x | docs/decode.h.3 | 42 |
1 files changed, 1 insertions, 41 deletions
diff --git a/docs/decode.h.3 b/docs/decode.h.3 index 447c67b..965d07f 100755 --- a/docs/decode.h.3 +++ b/docs/decode.h.3 @@ -1,4 +1,4 @@ -.TH "decode.h" 3 "Tue Jun 13 2017" "Brotli" \" -*- nroff -*- +.TH "decode.h" 3 "Wed Aug 2 2017" "Brotli" \" -*- nroff -*- .ad l .nh .SH NAME @@ -72,10 +72,6 @@ decode.h \- API for Brotli decompression\&. .br .RI "\fIChecks if instance has already consumed input\&. \fP" .ti -1c -.RI "void \fBBrotliDecoderSetCustomDictionary\fP (\fBBrotliDecoderState\fP *state, size_t size, const uint8_t dict[size])" -.br -.RI "\fIPrepends LZ77 dictionary\&. \fP" -.ti -1c .RI "\fBBROTLI_BOOL\fP \fBBrotliDecoderSetParameter\fP (\fBBrotliDecoderState\fP *state, \fBBrotliDecoderParameter\fP param, uint32_t value)" .br .RI "\fISets the specified parameter to the given decoder instance\&. \fP" @@ -346,42 +342,6 @@ Checks if instance has already consumed input\&. Instance that returns \fBBROTLI .RE .PP -.SS "void BrotliDecoderSetCustomDictionary (\fBBrotliDecoderState\fP * state, size_t size, const uint8_t dict[size])" - -.PP -Prepends LZ77 dictionary\&. Fills the fresh \fBBrotliDecoderState\fP with additional data corpus for LZ77 backward references\&. -.PP -\fBNote:\fP -.RS 4 -Not to be confused with the static dictionary (see RFC7932 section 8)\&. -.RE -.PP -\fBWarning:\fP -.RS 4 -The dictionary must exist in memory until decoding is done and is owned by the caller\&. -.RE -.PP -Workflow: -.IP "1." 4 -Allocate and initialize state with \fBBrotliDecoderCreateInstance\fP -.IP "2." 4 -Invoke \fBBrotliDecoderSetCustomDictionary\fP -.IP "3." 4 -Use \fBBrotliDecoderDecompressStream\fP -.IP "4." 4 -Clean up and free state with \fBBrotliDecoderDestroyInstance\fP -.PP -.PP -\fBParameters:\fP -.RS 4 -\fIstate\fP decoder instance -.br -\fIsize\fP length of \fCdict\fP; should be less or equal to 2^24 (16MiB), otherwise the dictionary will be ignored -.br -\fIdict\fP 'dictionary'; \fBMUST\fP be the same as used during compression -.RE -.PP - .SS "\fBBROTLI_BOOL\fP BrotliDecoderSetParameter (\fBBrotliDecoderState\fP * state, \fBBrotliDecoderParameter\fP param, uint32_t value)" .PP |