inline docs improvements

diff --git a/lib/packer/file_packer.php b/lib/packer/file_packer.php
index dcc0ddaff959421d4791aa05daee4e83fec5d66a..d8a6927f79ba06a8b16d40d978a20d24a474c038 100644 (file)
--- 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 880ba2a6c08a122e2c37d2e435b05c01852795d7..0704450efb57297bc3a44979d8855608b5bcafda 100644 (file)
--- 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) {