changed docs for readAll in File and helma.File to reflect that it seems to be intended to return a String, not an Array

This commit is contained in:
zumbrunn 2007-03-14 10:11:24 +00:00
parent 3016b4e32e
commit 6ec1380e56

View file

@ -9,9 +9,9 @@
* Copyright 1998-2007 Helma Software. All Rights Reserved. * Copyright 1998-2007 Helma Software. All Rights Reserved.
* *
* $RCSfile: File.js,v $ * $RCSfile: File.js,v $
* $Author: hannes $ * $Author: czv $
* $Revision: 1.3 $ * $Revision: 1.4 $
* $Date: 2006/07/25 20:07:59 $ * $Date: 2007/02/07 23:37:23 $
*/ */
@ -546,11 +546,11 @@ helma.File = function(path) {
}; };
/** /**
* This methods reads the rest of the file and returns an * This methods reads all the lines contained in the
* array with a slot for each line of the file. * file and returns them.
* *
* @returns Array of the remaining unread lines in the file * @return String of all the lines in the file
* @type Array * @type String
*/ */
this.readAll = function() { this.readAll = function() {
// Open the file for readAll // Open the file for readAll