fixed docs for File.prototype.renameTo and helma.File.renameTo to show that the expected argument is of type FileObject, not String

This commit is contained in:
zumbrunn 2007-07-31 19:50:05 +00:00
parent 62e88d817a
commit 54d348d904

View file

@ -10,8 +10,8 @@
* *
* $RCSfile: File.js,v $ * $RCSfile: File.js,v $
* $Author: czv $ * $Author: czv $
* $Revision: 1.4 $ * $Revision: 1.5 $
* $Date: 2007/02/07 23:37:23 $ * $Date: 2007/03/14 10:11:24 $
*/ */
@ -494,7 +494,7 @@ helma.File = function(path) {
* value should always be checked to make sure that the * value should always be checked to make sure that the
* rename operation was successful. * rename operation was successful.
* *
* @param {String} toFile as String, new pathname for the named file * @param {FileObject} toFile as FileObject of the new path
* @returns true if the renaming succeeded; false otherwise * @returns true if the renaming succeeded; false otherwise
* @type Boolean * @type Boolean
*/ */