antville/helma
antville/helma
1
1
Fork 0
Code Issues 5 Pull requests 7 Projects Releases 5 Activity Actions

changed docs for file.list methods, attempting to work around a JSDoc rendering problem

Browse source
This commit is contained in:
zumbrunn 2007-07-31 21:24:08 +00:00
parent 54d348d904
commit 437d603faf
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
helma/File.js
View file

@ -10,8 +10,8 @@
* *
* $RCSfile: File.js,v $ * $RCSfile: File.js,v $
* $Author: czv $ * $Author: czv $
* $Revision: 1.5 $ * $Revision: 1.6 $
* $Date: 2007/03/14 10:11:24 $ * $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. * List of all files within the directory represented by this File object.
* <br /><br /> * <br /><br />
* You may pass a RegExp Pattern to return just files matching this pattern. * You may pass a RegExp Pattern to return just files matching this pattern.
* <br /><br />
* 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 * @param {RegExp} pattern as RegExp, optional pattern to test each file name against
* @returns Array the list of file names * @returns Array the list of file names
* @type Array
*/ */
this.list = function(pattern) { this.list = function(pattern) {
if (self.isOpened()) if (self.isOpened())