[quakefs] Document that QFS_LoadFile closes the file

In the end, I decided that the behavior isn't so bad, but it does need to
be documented.

Closes #34
This commit is contained in:
Bill Currie 2023-11-19 16:40:24 +09:00
parent e8b2822587
commit 70d07d8026

View file

@ -252,6 +252,10 @@ QFile *QFS_FOpenFile (const char *filename);
data. Use 0.
\return Pointer to the file's data, or NULL on error.
\todo remove \a usehunk
\note The file is closed on return as any error is either file not found
(\a file is null) or there was a memory allocation error (bigger
problems).
*/
byte *QFS_LoadFile (QFile *file, int usehunk);