real_tabasco_sauce/0ad
1
0
Fork 0
forked from 0ad/0ad
Code Pull Requests Actions Activity

more revisions to comments to match dox

Browse Source 
This was SVN commit r2229.
This commit is contained in:
janwas 2005-05-03 16:57:56 +00:00
parent b8cb80898f
commit f34cd1ee08
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/ps/scripting/JSInterface_VFS.cpp
View File

@ -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 // Return an array of pathname strings, one for each matching entry in the
// specified directory. // specified directory.
// //
// array_of_filenames = buildFileList(start_path [, filter_string [, recursive ] ]); // pathnames = buildFileList(start_path [, filter_string [, recursive ] ]);
// directory: VFS path // directory: VFS path
// filter_string: default "" matches everything; otherwise, see vfs_next_dirent. // filter_string: default "" matches everything; otherwise, see vfs_next_dirent.
// recurse: should subdirectories be included in the search? default false. // 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) // filename: VFS filename (may include path)
JSBool JSI_VFS::GetFileMTime( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ) 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. // Return file contents in a string.
// //
// contents_string = readFile(filename); // contents = readFile(filename);
// filename: VFS filename (may include path) // filename: VFS filename (may include path)
JSBool JSI_VFS::ReadFile( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ) 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. // Return file contents as an array of lines.
// //
// array_of_strings = readFileLines(filename); // lines = readFileLines(filename);
// filename: VFS filename (may include path) // filename: VFS filename (may include path)
JSBool JSI_VFS::ReadFileLines( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ) JSBool JSI_VFS::ReadFileLines( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval )
{ {

10
source/ps/scripting/JSInterface_VFS.h
View File

@ -14,7 +14,7 @@ namespace JSI_VFS
// Return an array of pathname strings, one for each matching entry in the // Return an array of pathname strings, one for each matching entry in the
// specified directory. // specified directory.
// //
// array_of_filenames = buildFileList(start_path [, filter_string [, recursive ] ]); // pathnames = buildFileList(start_path [, filter_string [, recursive ] ]);
// directory: VFS path // directory: VFS path
// filter_string: default "" matches everything; otherwise, see vfs_next_dirent. // filter_string: default "" matches everything; otherwise, see vfs_next_dirent.
// recurse: should subdirectories be included in the search? default false. // 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. // ready for use as a "filename" for the other functions.
JSBool BuildFileList( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); 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) // filename: VFS filename (may include path)
JSBool GetFileMTime( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); 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. // Return file contents in a string.
// //
// contents_string = readFile(filename); // contents = readFile(filename);
// filename: VFS filename (may include path) // filename: VFS filename (may include path)
JSBool ReadFile( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); JSBool ReadFile( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval );
// Return file contents as an array of lines. // Return file contents as an array of lines.
// //
// array_of_strings = readFileLines(filename); // lines = readFileLines(filename);
// filename: VFS filename (may include path) // filename: VFS filename (may include path)
JSBool ReadFileLines( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval ); JSBool ReadFileLines( JSContext* cx, JSObject* obj, uintN argc, jsval* argv, jsval* rval );
}; };