MDL-18111 improving file api comments and docs, fixing license header

diff --git a/lib/file/file_browser.php b/lib/file/file_browser.php
index c873cd1691f492812c1a9623f122b28791438af7..680bf6b7841ae96c211c62e1a4e7913d98f6de8d 100644 (file)
--- a/lib/file/file_browser.php
+++ b/lib/file/file_browser.php
@@ -19,9 +19,10 @@
 /**
  * Utility class for browsing of files.
  *
- * @package   moodle-core
- * @copyright 2008 Petr Skoda (http://skodak.org)
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once("$CFG->libdir/file/file_info.php");

diff --git a/lib/file/file_info.php b/lib/file/file_info.php
index f6eb9928ca3b73f8ad1de4e270c40fb83546a890..aced4783c612dd210d635662b836f76150551267 100644 (file)
--- a/lib/file/file_info.php
+++ b/lib/file/file_info.php
@@ -1,5 +1,30 @@
 <?php
 
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Base for all file browsing classes.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 /**
  * Base class for things in the tree navigated by @see{file_browser}.
  */

diff --git a/lib/file/file_info_course.php b/lib/file/file_info_course.php
index 7cbcb403fe825c475352594b230d65c346585459..056963ce31df00d472ae0bffb2acf931c876bb54 100644 (file)
--- a/lib/file/file_info_course.php
+++ b/lib/file/file_info_course.php
@@ -1,4 +1,29 @@
-<?php  //$Id$
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Utility class for browsing of course files.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Represents a course context in the tree navigated by @see{file_browser}.

diff --git a/lib/file/file_info_coursecat.php b/lib/file/file_info_coursecat.php
index 409d8f9d9ff35e79ff72b7121fd603085fbfd5a5..57e6de21217466fab9d038510e8ec5d72da19f39 100644 (file)
--- a/lib/file/file_info_coursecat.php
+++ b/lib/file/file_info_coursecat.php
@@ -1,4 +1,29 @@
-<?php  //$Id$
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Utility class for browsing of curse category files.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Represents a course category context in the tree navigated by @see{file_browser}.

diff --git a/lib/file/file_info_coursefile.php b/lib/file/file_info_coursefile.php
index d8c9593289a7e9b6863690618463d2fd72c09ec7..6ddacadce48677714494b36172f8a1c0ec924d39 100644 (file)
--- a/lib/file/file_info_coursefile.php
+++ b/lib/file/file_info_coursefile.php
@@ -17,11 +17,12 @@
 
 
 /**
- * Class for browsing of legacy course files.
+ * Utility class for browsing of coursefiles.
  *
- * @package   moodle-core
- * @copyright 2008 Petr Skoda (http://skodak.org)
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 /**

diff --git a/lib/file/file_info_coursesection.php b/lib/file/file_info_coursesection.php
index 1c7b431c4ff041da6884f8b784076f9dae9afaf4..d3ef0cff1f83b300ff5bb81875b8b304a461fffb 100644 (file)
--- a/lib/file/file_info_coursesection.php
+++ b/lib/file/file_info_coursesection.php
@@ -1,4 +1,29 @@
-<?php  //$Id$
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Utility class for browsing of course section files.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Represents a course category context in the tree navigated by @see{file_browser}.

diff --git a/lib/file/file_info_module.php b/lib/file/file_info_module.php
index a027fd3f9428e81249b193c60714cb54768222e7..375b2da22e66322d1825389fe13d725a3f3fe478 100644 (file)
--- a/lib/file/file_info_module.php
+++ b/lib/file/file_info_module.php
@@ -1,4 +1,29 @@
-<?php  //$Id$
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Utility class for browsing of module files.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Represents a module context in the tree navigated by @see{file_browser}.

diff --git a/lib/file/file_info_stored.php b/lib/file/file_info_stored.php
index d8e12fbb09c4a72041d1cdbc5b64b52bd13e3bd4..e4d82c142d9bd99a66dd4488cfb56cde62c934ca 100644 (file)
--- a/lib/file/file_info_stored.php
+++ b/lib/file/file_info_stored.php
@@ -19,9 +19,10 @@
 /**
  * Utility class for browsing of stored files.
  *
- * @package   moodle-core
- * @copyright 2008 Petr Skoda (http://skodak.org)
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 /**

diff --git a/lib/file/file_info_system.php b/lib/file/file_info_system.php
index f2bcb175f11e71042b592f127cceebe53819228c..3a96830e41c06769e01f8a4bf81af09f7f369b6e 100644 (file)
--- a/lib/file/file_info_system.php
+++ b/lib/file/file_info_system.php
@@ -1,4 +1,29 @@
-<?php  //$Id$
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Utility class for browsing of system files.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Represents the system context in the tree navigated by @see{file_browser}.

diff --git a/lib/file/file_info_user.php b/lib/file/file_info_user.php
index bf6e62d7e20e1026b4336478cd2cd8c503cc623f..a8856ce9b58a78acf775c26b26185746b24c3586 100644 (file)
--- a/lib/file/file_info_user.php
+++ b/lib/file/file_info_user.php
@@ -1,4 +1,29 @@
-<?php  //$Id$
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Utility class for browsing of user files.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Represents a user context in the tree navigated by @see{file_browser}.

diff --git a/lib/file/file_storage.php b/lib/file/file_storage.php
index 3d3d0630b43d8ef4b018b21f17dbb144df492027..d4edcc3ed1b829f98684e5381828f3bd78adfb29 100644 (file)
--- a/lib/file/file_storage.php
+++ b/lib/file/file_storage.php
@@ -19,9 +19,10 @@
 /**
  * Core file storage class definition.
  *
- * @package   moodle-core
- * @copyright 2008 Petr Skoda (http://skodak.org)
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    moodlecore
+ * @subpackage file-storage
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once("$CFG->libdir/file/stored_file.php");

diff --git a/lib/file/stored_file.php b/lib/file/stored_file.php
index 85691fd4c5fc9538f0e030770296e7876c8a45bc..542f971c66eb9bad678057d5c1faeb5892999023 100644 (file)
--- a/lib/file/stored_file.php
+++ b/lib/file/stored_file.php
@@ -19,9 +19,10 @@
 /**
  * Class representing filesin Moodle file storage.
  *
- * @package   moodle-core
- * @copyright 2008 Petr Skoda (http://skodak.org)
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    moodlecore
+ * @subpackage file-storage
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once("$CFG->libdir/file/stored_file.php");

diff --git a/lib/file/virtual_root_file.php b/lib/file/virtual_root_file.php
index e97fdd15b4b681595b592d7acb9e40062bfd3d12..975e8a82157ed5bc4c5e532423525fd34b0ca726 100644 (file)
--- a/lib/file/virtual_root_file.php
+++ b/lib/file/virtual_root_file.php
@@ -1,4 +1,29 @@
-<?php  //$Id$
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+
+/**
+ * Class simulating empty directories.
+ *
+ * @package    moodlecore
+ * @subpackage file-browser
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Represents the root directory of an empty file area in the tree navigated by

diff --git a/lib/filelib.php b/lib/filelib.php
index 4089f10a594888d6684e26df37e2d8f9002912d0..cadae14bbba71b48d1c4e61cdcf6d7e92db3dd8e 100644 (file)
--- a/lib/filelib.php
+++ b/lib/filelib.php
@@ -1,33 +1,27 @@
-<?php //$Id$
-
-///////////////////////////////////////////////////////////////////////////
-//                                                                       //
-// NOTICE OF COPYRIGHT                                                   //
-//                                                                       //
-// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
-//          http://moodle.org                                            //
-//                                                                       //
-// Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com     //
-//                                                                       //
-// This program is free software; you can redistribute it and/or modify  //
-// it under the terms of the GNU General Public License as published by  //
-// the Free Software Foundation; either version 2 of the License, or     //
-// (at your option) any later version.                                   //
-//                                                                       //
-// This program is distributed in the hope that it will be useful,       //
-// but WITHOUT ANY WARRANTY; without even the implied warranty of        //
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
-// GNU General Public License for more details:                          //
-//                                                                       //
-//          http://www.gnu.org/copyleft/gpl.html                         //
-//                                                                       //
-///////////////////////////////////////////////////////////////////////////
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
  * Functions for file handling.
  *
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package files
+ * @package    moodlecore
+ * @subpackage file
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  */
 
 /** @var string unique string constant. */