From 437d603fafbe4825602e06b2f4110a11ffa937d3 Mon Sep 17 00:00:00 2001 From: zumbrunn Date: Tue, 31 Jul 2007 21:24:08 +0000 Subject: [PATCH] changed docs for file.list methods, attempting to work around a JSDoc rendering problem --- helma/File.js | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/helma/File.js b/helma/File.js index e4e0d38a..97ee66b0 100644 --- a/helma/File.js +++ b/helma/File.js @@ -10,8 +10,8 @@ * * $RCSfile: File.js,v $ * $Author: czv $ - * $Revision: 1.5 $ - * $Date: 2007/03/14 10:11:24 $ + * $Revision: 1.6 $ + * $Date: 2007/07/31 19:50:05 $ */ @@ -270,10 +270,12 @@ helma.File = function(path) { * List of all files within the directory represented by this File object. *

* You may pass a RegExp Pattern to return just files matching this pattern. + *

+ * Example: var xmlFiles = dir.list(/.*\.xml/); * - * @example var xmlFiles = dir.list(/.*\.xml/); * @param {RegExp} pattern as RegExp, optional pattern to test each file name against * @returns Array the list of file names + * @type Array */ this.list = function(pattern) { if (self.isOpened())