libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2024-12-12 03:56:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

COMMON: Add comments on usage

Browse Source
This commit is contained in:
elasota 2023-06-05 11:34:12 -04:00 committed by Filippos Karapetis
parent 907252ecbd
commit 654f7fd8d0
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
common/compression/stuffit.h
View File

@ -50,7 +50,10 @@ class SeekableReadStream;
* This factory method creates an Archive instance corresponding to the content
* of the StuffIt compressed file with the given name.
*
* May return 0 in case of a failure.
* @param fileName The file name to load
* @param flattenTree If true, removes the directory prefixes from all file paths
*
* @return The StuffIt archive
*/
Archive *createStuffItArchive(const String &fileName, bool flattenTree = false);
Archive *createStuffItArchive(SeekableReadStream *stream, bool flattenTree = false);