From 9f611ae66d06e94fc2df9a1a96c7c7bf65d659de Mon Sep 17 00:00:00 2001 From: Max Horn Date: Sun, 30 Dec 2007 00:00:03 +0000 Subject: Clarify SaveFileManager::listSavefiles usage svn-id: r30077 --- common/savefile.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'common') diff --git a/common/savefile.h b/common/savefile.h index 4f9288ac05..5b06248aa8 100644 --- a/common/savefile.h +++ b/common/savefile.h @@ -148,11 +148,14 @@ public: virtual bool renameSavefile(const char *oldFilename, const char *newFilename); /** - * Request a list of available savegames with a given regex. - * @param regex Regular expression to match. Wildcards like * or ? are available. - * returns a list of strings for all present file names. + * Request a list of available savegames with a given DOS-style pattern, + * also known as "glob" in the UNIX world. Refer to the Common::match() + * function to learn about the precise pattern format. + * @param pattern Pattern to match. Wildcards like * or ? are available. + * @return list of strings for all present file names. + * @see Common::match */ - virtual Common::StringList listSavefiles(const char *regex) = 0; + virtual Common::StringList listSavefiles(const char *pattern) = 0; }; } // End of namespace Common -- cgit v1.2.3