lib/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-08-05 19:15:58 +03:00
Code Activity

updated UTIL_createFileNamesTable() inline documentation

Browse Source
This commit is contained in:
Yann Collet
2019-10-28 15:20:40 -07:00
parent 170982fbd9
commit 65f2d97f33
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
programs/util.h
View File

@@ -151,20 +151,19 @@ typedef struct
size_t tableSize; size_t tableSize;
} FileNamesTable; } FileNamesTable;
/*! UTIL_readFileNamesTableFromFile() : /*! UTIL_createFileNamesTable_fromFileName() :
* reads fileNamesTable from @inputFileName. * read filenames from @inputFileName, and store them into returned object.
* @return : a FileNamesTable*, or NULL in case of error (ex: file doesn't exist). * @return : a FileNamesTable*, or NULL in case of error (ex: @inputFileName doesn't exist).
* Note: inputFileSize must be less than 50MB * Note: inputFileSize must be less than 50MB
*/ */
FileNamesTable* FileNamesTable*
UTIL_createFileNamesTable_fromFileName(const char* inputFileName); UTIL_createFileNamesTable_fromFileName(const char* inputFileName);
/*! UTIL_createFileNamesTable() :
/*! UTIL_freeFileNamesTable() : * This function takes ownership of its arguments, @filenames and @buf,
* This function references its arguments inside the created object. * and store them inside the created object.
* @return : FileNamesTable*, or NULL, if allocation fails. * @return : FileNamesTable*, or NULL, if allocation fails.
*/ */
FileNamesTable* FileNamesTable*
UTIL_createFileNamesTable(const char** filenames, size_t tableSize, char* buf); UTIL_createFileNamesTable(const char** filenames, size_t tableSize, char* buf);
@@ -204,8 +203,9 @@ int UTIL_prepareFileList(const char* dirName, char** bufStart, size_t* pos, char
#endif /* #ifdef _WIN32 */ #endif /* #ifdef _WIN32 */
/* /*
* UTIL_createFileList - takes a list of files and directories (params: inputNames, inputNamesNb), scans directories, * UTIL_createFileList() :
* and returns a new list of files (params: return value, allocatedBuffer, allocatedNamesNb). * takes a list of files and directories (params: inputNames, inputNamesNb), scans directories,
* and returns a new list of files (params: return value, allocatedBuffer, allocatedNamesNb).
* After finishing usage of the list the structures should be freed with UTIL_freeFileList(params: return value, allocatedBuffer) * After finishing usage of the list the structures should be freed with UTIL_freeFileList(params: return value, allocatedBuffer)
* In case of error UTIL_createFileList returns NULL and UTIL_freeFileList should not be called. * In case of error UTIL_createFileList returns NULL and UTIL_freeFileList should not be called.
*/ */