Add documentation for new api functions
This commit is contained in:
+18
@@ -1328,11 +1328,29 @@ ZSTDLIB_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
|
||||
*/
|
||||
ZSTDLIB_API size_t ZSTD_mergeBlockDelimiters(ZSTD_Sequence* sequences, size_t seqsSize);
|
||||
|
||||
/*! ZSTD_compressSequencesCCtx() :
|
||||
* Compress sequences given by inSeqs, generated from source buffer 'src', using a cctx.
|
||||
* The entire source is compressed into a single frame.
|
||||
*
|
||||
* If invoked with ZSTD_sf_noBlockDelimiters, the array of ZSTD_Sequence is expected to contain
|
||||
* no block delimiters (defined in ZSTD_Sequence). Block boundaries are roughly determined based on
|
||||
* the block size derived from the cctx, and sequences may be split.
|
||||
*
|
||||
* If invoked with ZSTD_sf_explicitBlockDelimiters, the array of ZSTD_Sequence is expected to contain
|
||||
* block delimiters.
|
||||
*
|
||||
* @return : final compressed size.
|
||||
*/
|
||||
ZSTDLIB_API size_t ZSTD_compressSequencesCCtx(ZSTD_CCtx* const cctx, void* dst, size_t dstSize,
|
||||
const ZSTD_Sequence* inSeqs, size_t inSeqsSize,
|
||||
const void* src, size_t srcSize,
|
||||
ZSTD_sequenceFormat_e format);
|
||||
|
||||
/*! ZSTD_compressSequences() :
|
||||
* Creates a default CCtx based on the given compression level, and invokes ZSTD_compressSequencesCCtx().
|
||||
*
|
||||
* @return : final compressed size.
|
||||
*/
|
||||
ZSTDLIB_API size_t ZSTD_compressSequences(void* dst, size_t dstSize,
|
||||
const ZSTD_Sequence* inSeqs, size_t inSeqsSize,
|
||||
const void* src, size_t srcSize, int compressionLevel,
|
||||
|
||||
Reference in New Issue
Block a user