From: skodak <skodak>
Date: Thu, 21 May 2009 08:25:52 +0000 (+0000)
Subject: MDL-18111 improving file api comments and docs, fixing license header
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=64a19b3828c174dc75e501529d8dbc9e6a73097e;p=moodle.git

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 c873cd1691..680bf6b784 100644
--- 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 f6eb9928ca..aced4783c6 100644
--- 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 7cbcb403fe..056963ce31 100644
--- 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 409d8f9d9f..57e6de2121 100644
--- 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 d8c9593289..6ddacadce4 100644
--- 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 1c7b431c4f..d3ef0cff1f 100644
--- 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 a027fd3f94..375b2da22e 100644
--- 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 d8e12fbb09..e4d82c142d 100644
--- 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 f2bcb175f1..3a96830e41 100644
--- 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 bf6e62d7e2..a8856ce9b5 100644
--- 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 3d3d0630b4..d4edcc3ed1 100644
--- 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 85691fd4c5..542f971c66 100644
--- 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 e97fdd15b4..975e8a8215 100644
--- 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 4089f10a59..cadae14bbb 100644
--- 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. */