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

diff --git a/lib/file/file_exceptions.php b/lib/file/file_exceptions.php
index 8fbf84e62fc6c3b630d2b0fab6127dab2ec51e1c..78d5c980d5de07fd20f4b9c76fc941f7d2d0524e 100644 (file)
--- a/lib/file/file_exceptions.php
+++ b/lib/file/file_exceptions.php
@@ -1,4 +1,28 @@
-<?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/>.
+
+/**
+ * File handling related exceptions.
+ *
+ * @package    moodlecore
+ * @subpackage file
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Basic file related exception class
@@ -10,7 +34,7 @@ class file_exception extends moodle_exception {
 }
 
 /**
- * Table does not exist problem exception
+ * Can not create file exception
  */
 class stored_file_creation_exception extends file_exception {
     function __construct($contextid, $filearea, $itemid, $filepath, $filename, $debuginfo=null) {
@@ -25,7 +49,7 @@ class stored_file_creation_exception extends file_exception {
 }
 
 /**
- * Table does not exist problem exception
+ * No file access excetion.
  */
 class file_access_exception extends file_exception {
     function __construct($debuginfo=null) {
@@ -34,7 +58,7 @@ class file_access_exception extends file_exception {
 }
 
 /**
- * Hash file content problem
+ * Hash file content problem exception.
  */
 class file_pool_content_exception extends file_exception {
     function __construct($contenthash, $debuginfo=null) {

diff --git a/lib/filelib.php b/lib/filelib.php
index cadae14bbba71b48d1c4e61cdcf6d7e92db3dd8e..fc65e0b9f0ab29bb44001381683a33b8b00fccd1 100644 (file)
--- a/lib/filelib.php
+++ b/lib/filelib.php
@@ -20,8 +20,8 @@
  *
  * @package    moodlecore
  * @subpackage file
- * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 /** @var string unique string constant. */

diff --git a/lib/packer/file_archive.php b/lib/packer/file_archive.php
index 59b7107729413f5ca23a4a67147eb1048b7ec5a0..7f1385893dfdf3886c663e0c2bdd5e78747d91e9 100644 (file)
--- a/lib/packer/file_archive.php
+++ b/lib/packer/file_archive.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/>.
+
+
+/**
+ * Abstraction of general file archives.
+ *
+ * @package    moodlecore
+ * @subpackage file-packer
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 abstract class file_archive implements Iterator {
 

diff --git a/lib/packer/file_packer.php b/lib/packer/file_packer.php
index 1dc7d3b858bba3b85029b188c0764f1624c42ba3..f04d0714a321bae39c65b4f3eee65a5b334ecf44 100644 (file)
--- a/lib/packer/file_packer.php
+++ b/lib/packer/file_packer.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/>.
+
+
+/**
+ * Abstraction of general file packer.
+ *
+ * @package    moodlecore
+ * @subpackage file-packer
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 /**
  * Abstract class for archiving of files.

diff --git a/lib/packer/zip_archive.php b/lib/packer/zip_archive.php
index 7cae281fe1d0057473fd4e42b8941561a5b9f7f1..99a087bc4bc63229b00b7b11aaa4b8ee0ed3f164 100644 (file)
--- a/lib/packer/zip_archive.php
+++ b/lib/packer/zip_archive.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/>.
+
+
+/**
+ * Implementation of zip file archive.
+ *
+ * @package    moodlecore
+ * @subpackage file-packer
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 require_once("$CFG->libdir/packer/file_archive.php");
 

diff --git a/lib/packer/zip_packer.php b/lib/packer/zip_packer.php
index 297b890b9993c14ac21d0cafb015577d94299b8d..6ea044e7f8b1777dd8f13ef6bbd97a8b88ce13d9 100644 (file)
--- a/lib/packer/zip_packer.php
+++ b/lib/packer/zip_packer.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/>.
+
+
+/**
+ * Implementation of zip packer.
+ *
+ * @package    moodlecore
+ * @subpackage file-packer
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 require_once("$CFG->libdir/packer/file_packer.php");
 require_once("$CFG->libdir/packer/zip_archive.php");