From: skodak <skodak>
Date: Tue, 12 Aug 2008 11:00:13 +0000 (+0000)
Subject: inline docs improvements
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=593bb2ebf572f5c52650dfe333ba6f72b51afeae;p=moodle.git

inline docs improvements
---

diff --git a/lib/packer/file_packer.php b/lib/packer/file_packer.php
index dcc0ddaff9..d8a6927f79 100644
--- a/lib/packer/file_packer.php
+++ b/lib/packer/file_packer.php
@@ -7,7 +7,7 @@ abstract class file_packer {
 
     /**
      * archive files and store the result in file storage
-     * @param array $archivepath=>$pathanme or stored file instance
+     * @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file) 
      * @param int $contextid
      * @param string $filearea
      * @param int $itemid
@@ -19,8 +19,8 @@ abstract class file_packer {
 
     /**
      * Archive files and store the result in os file
-     * @param array $archivepath=>$pathanme or stored file instance
-     * @param string $archivefile
+     * @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file) 
+     * @param string $archivefile path to target zip file
      * @return bool success
      */
     public abstract function archive_to_pathname($files, $archivefile);
diff --git a/lib/packer/zip_packer.php b/lib/packer/zip_packer.php
index 880ba2a6c0..0704450efb 100644
--- a/lib/packer/zip_packer.php
+++ b/lib/packer/zip_packer.php
@@ -10,7 +10,7 @@ class zip_packer extends file_packer {
 
     /**
      * Zip files and store the result in file storage
-     * @param array $archivepath=>$pathanme or stored file instance
+     * @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file) 
      * @param int $contextid
      * @param string $filearea
      * @param int $itemid
@@ -49,8 +49,8 @@ class zip_packer extends file_packer {
 
     /**
      * Zip files and store the result in os file
-     * @param array $archivepath=>$pathanme or stored file instance
-     * @param string $archivefile
+     * @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file) 
+     * @param string $archivefile path to target zip file
      * @return bool success
      */
     public function archive_to_pathname($files, $archivefile) {