qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-11-10 15:22:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add some docs for expand_squiggle.

Browse source
This commit is contained in:
Bill Currie 2010-08-23 12:21:40 +09:00
parent 9bae615577
commit fcdd046333
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
include/QF/quakefs.h
View file

@ -133,7 +133,18 @@ void QFS_FilelistEnumerate(filelist_t* list, const char* path);
qboolean QFS_IsDirectory (const char *path);
// FIXME: This is here temporarily until fs_usercfg gets sorted out
/** Expand leading "~/" in \a path to the user's home directory.
On Linux-like systems, the user's home directory is obtained from the
system, or failing that, the \c HOME environment variable.
On Windows systems, first the \c HOME environment variable is checked.
If \c HOME is not set, \c WINDIR is used.
\param path the path to check for "~/"
\return the expanded path
\note It is the caller's responsibility to free the returned string.
FIXME: rename to QFS_*
*/
char *expand_squiggle (const char *path);
//@}