]> git.mjollnir.org Git - moodle.git/commitdiff
MDL-13766: improve documentation
authorscyrma <scyrma>
Fri, 22 Aug 2008 06:06:02 +0000 (06:06 +0000)
committerscyrma <scyrma>
Fri, 22 Aug 2008 06:06:02 +0000 (06:06 +0000)
repository/lib.php

index 2e3a6125f12ace545b185c88ead958286f560ec0..a7d606c91780b6fca109bcddce77d0ac16204048 100644 (file)
@@ -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)
      *       )
      *     ), 
      *   )