From: scyrma <scyrma>
Date: Fri, 22 Aug 2008 06:06:02 +0000 (+0000)
Subject: MDL-13766: improve documentation
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=3c9e53c05e6913cdb3feca52bf8107905857c60c;p=moodle.git

MDL-13766: improve documentation
---

diff --git a/repository/lib.php b/repository/lib.php
index 2e3a6125f1..a7d606c917 100644
--- a/repository/lib.php
+++ b/repository/lib.php
@@ -363,17 +363,17 @@ abstract class repository {
      *     array( // file
      *       'title' => (string) file name,
      *       'size' => (int) file size,
-     *       'date' => (string) file last modification, usually userdate(...),
-     *       'thumbnail' => (string) path to thumbnail for the file,
-     *       'source' => (string) path to the file itself
+     *       'date' => (string) file last modification time, usually userdate(...),
+     *       'thumbnail' => (string) url to thumbnail for the file,
+     *       'source' => (string) url to the file itself
      *     ),
-     *     array( // subfolder - same as file, but no 'source'
+     *     array( // folder - same as file, but no 'source'.
      *       'title' => (string) folder name,
      *       'size' => 0,
-     *       'date' => (string) folder last modification, usually userdate(...),
-     *       'thumbnail' => (string) path to thumbnail for the folder,
-     *       'children' => array(
-     *         // content of folder, (files or folders)
+     *       'date' => (string) folder last modification time, usually userdate(...),
+     *       'thumbnail' => (string) url to thumbnail for the folder,
+     *       'children' => array( // an empty folder needs to have 'children' defined, but empty.
+     *         // content (files and folders)
      *       )
      *     ), 
      *   )