From f34cd1ee080609513ffee507863d22a1792663ba Mon Sep 17 00:00:00 2001 From: janwas Date: Tue, 3 May 2005 16:57:56 +0000 Subject: [PATCH] more revisions to comments to match dox This was SVN commit r2229. --- source/ps/scripting/JSInterface_VFS.cpp | 10 +++++----- source/ps/scripting/JSInterface_VFS.h | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/source/ps/scripting/JSInterface_VFS.cpp b/source/ps/scripting/JSInterface_VFS.cpp index e1049e9b1a..890ce9d2c7 100644 --- a/source/ps/scripting/JSInterface_VFS.cpp +++ b/source/ps/scripting/JSInterface_VFS.cpp @@ -56,7 +56,7 @@ static void BuildFileListCB(const char* path, const vfsDirEnt* ent, void* contex // Return an array of pathname strings, one for each matching entry in the // specified directory. // -// array_of_filenames = buildFileList(start_path [, filter_string [, recursive ] ]); +// pathnames = buildFileList(start_path [, filter_string [, recursive ] ]); // directory: VFS path // filter_string: default "" matches everything; otherwise, see vfs_next_dirent. // recurse: should subdirectories be included in the search? default false. @@ -103,9 +103,9 @@ JSBool JSI_VFS::BuildFileList( JSContext* cx, JSObject* obj, uintN argc, jsval* } -// Return timestamp of the last modification to the specified file. +// Return time [seconds since 1970] of the last modification to the specified file. // -// seconds_since_1970 = getFileMTime(filename); +// mtime = getFileMTime(filename); // filename: VFS filename (may include path) JSBool JSI_VFS::GetFileMTime( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ) { @@ -145,7 +145,7 @@ JSBool JSI_VFS::GetFileSize( JSContext* cx, JSObject* obj, uintN argc, jsval* ar // Return file contents in a string. // -// contents_string = readFile(filename); +// contents = readFile(filename); // filename: VFS filename (may include path) JSBool JSI_VFS::ReadFile( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ) { @@ -169,7 +169,7 @@ JSBool JSI_VFS::ReadFile( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, // Return file contents as an array of lines. // -// array_of_strings = readFileLines(filename); +// lines = readFileLines(filename); // filename: VFS filename (may include path) JSBool JSI_VFS::ReadFileLines( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ) { diff --git a/source/ps/scripting/JSInterface_VFS.h b/source/ps/scripting/JSInterface_VFS.h index 43089ec97e..817fd1c912 100644 --- a/source/ps/scripting/JSInterface_VFS.h +++ b/source/ps/scripting/JSInterface_VFS.h @@ -14,7 +14,7 @@ namespace JSI_VFS // Return an array of pathname strings, one for each matching entry in the // specified directory. // - // array_of_filenames = buildFileList(start_path [, filter_string [, recursive ] ]); + // pathnames = buildFileList(start_path [, filter_string [, recursive ] ]); // directory: VFS path // filter_string: default "" matches everything; otherwise, see vfs_next_dirent. // recurse: should subdirectories be included in the search? default false. @@ -23,9 +23,9 @@ namespace JSI_VFS // ready for use as a "filename" for the other functions. JSBool BuildFileList( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); - // Return timestamp of the last modification to the specified file. + // Return time [seconds since 1970] of the last modification to the specified file. // - // seconds_since_1970 = getFileMTime(filename); + // mtime = getFileMTime(filename); // filename: VFS filename (may include path) JSBool GetFileMTime( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); @@ -37,13 +37,13 @@ namespace JSI_VFS // Return file contents in a string. // - // contents_string = readFile(filename); + // contents = readFile(filename); // filename: VFS filename (may include path) JSBool ReadFile( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); // Return file contents as an array of lines. // - // array_of_strings = readFileLines(filename); + // lines = readFileLines(filename); // filename: VFS filename (may include path) JSBool ReadFileLines( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); };