added comment on public ddict functions

This commit is contained in:
Yann Collet 2018-10-24 16:50:03 -07:00
parent b7421f8e69
commit cb320a9fc0

View File

@ -16,17 +16,29 @@
* Dependencies * Dependencies
*********************************************************/ *********************************************************/
#include <stddef.h> /* size_t */ #include <stddef.h> /* size_t */
#include "zstd.h" /* ZSTD_DDict */ #include "zstd.h" /* ZSTD_DDict, and several public functions */
/*-******************************************************* /*-*******************************************************
* Interface * Interface
*********************************************************/ *********************************************************/
/* note: several prototypes are already published in `zstd.h` :
* ZSTD_createDDict()
* ZSTD_createDDict_byReference()
* ZSTD_createDDict_advanced()
* ZSTD_freeDDict()
* ZSTD_initStaticDDict()
* ZSTD_sizeof_DDict()
* ZSTD_estimateDDictSize()
* ZSTD_getDictID_fromDict()
*/
const void* ZSTD_DDict_dictContent(const ZSTD_DDict* ddict); const void* ZSTD_DDict_dictContent(const ZSTD_DDict* ddict);
size_t ZSTD_DDict_dictSize(const ZSTD_DDict* ddict); size_t ZSTD_DDict_dictSize(const ZSTD_DDict* ddict);
void ZSTD_copyDDictParameters(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict); void ZSTD_copyDDictParameters(ZSTD_DCtx* dctx, const ZSTD_DDict* ddict);
#endif /* ZSTD_DDICT_H */ #endif /* ZSTD_DDICT_H */