Updates comments of io classes/interfaces

diff --git a/wcfsetup/install/files/lib/system/io/IArchive.class.php b/wcfsetup/install/files/lib/system/io/IArchive.class.php
index 10b2f4583c1c1f434349baf386162179d9c24b73..566ed3ddbf5e98d1bbf8bb61e81d5b8bd09fc96c 100644 (file)
--- a/wcfsetup/install/files/lib/system/io/IArchive.class.php
+++ b/wcfsetup/install/files/lib/system/io/IArchive.class.php
@@ -13,15 +13,15 @@ namespace wcf\system\io;
  */
 interface IArchive {
        /** 
-        * Returns the table of contents (TOC) list for this tar archive.
+        * Returns the table of contents (TOC) list for this archive.
         * 
         * @return      array           list of content
         */
        public function getContentList();
        
        /**
-        * Returns an associative array with information
-        * about a specific file in the archive.
+        * Returns an associative array with information about a specific file
+        * in the archive.
         *
         * @param       mixed   $index  index or name of the requested file
         * @return      array
@@ -29,8 +29,8 @@ interface IArchive {
        public function getFileInfo($index);
        
        /**
-        * Extracts a specific file and returns the content as string.
-        * Returns false if extraction failed.
+        * Extracts a specific file and returns the content as string. Returns
+        * false if extraction failed.
         * 
         * @param       mixed           $index          index or name of the requested file
         * @return      string                          content of the requested file
@@ -38,8 +38,8 @@ interface IArchive {
        public function extractToString($index);
        
        /**
-        * Extracts a specific file and writes it's content
-        * to the file specified with $destination.
+        * Extracts a specific file and writes its content to the file specified
+        * with $destination.
         * 
         * @param       mixed           $index          index or name of the requested file
         * @param       string          $destination
@@ -48,8 +48,7 @@ interface IArchive {
        public function extract($index, $destination);
        
        /**
-        * Searchs a file in the tar archive
-        * and returns the numeric fileindex.
+        * Searchs a file in the archive and returns the numeric file index.
         * Returns false if not found.
         *
         * @param       string          $filename

diff --git a/wcfsetup/install/files/lib/system/io/Tar.class.php b/wcfsetup/install/files/lib/system/io/Tar.class.php
index 7210002e9cd96718d3d1f9f14408ff9225f0b45a..0e8fa1bac86eaf995644c2bb9183d7f976f1ec69 100644 (file)
--- a/wcfsetup/install/files/lib/system/io/Tar.class.php
+++ b/wcfsetup/install/files/lib/system/io/Tar.class.php
@@ -120,9 +120,7 @@ class Tar implements IArchive {
        }
        
        /** 
-        * Returns the table of contents (TOC) list for this tar archive.
-        * 
-        * @return      array           list of content
+        * @see wcf\system\io\IArchive::getContentList()
         */
        public function getContentList() {
                if (!$this->read) {
@@ -132,12 +130,8 @@ class Tar implements IArchive {
                return $this->contentList;
        }
        
-       /**
-        * Returns an associative array with information
-        * about a specific file in the archive.
-        *
-        * @param       mixed   $fileindex      index or name of the requested file
-        * @return      array   $fileInfo
+       /** 
+        * @see wcf\system\io\IArchive::getFileInfo()
         */
        public function getFileInfo($fileIndex) {
                if (!is_int($fileIndex)) {
@@ -150,13 +144,8 @@ class Tar implements IArchive {
                return $this->contentList[$fileIndex];
        }
        
-       /**
-        * Searchs a file in the tar archive
-        * and returns the numeric fileindex.
-        * Returns false if not found.
-        *
-        * @param       string          $filename
-        * @return      integer                         index of the requested file
+       /** 
+        * @see wcf\system\io\IArchive::getIndexByFilename()
         */
        public function getIndexByFilename($filename) {
                foreach ($this->contentList as $index => $file) {
@@ -167,12 +156,8 @@ class Tar implements IArchive {
                return false;
        }
        
-       /**
-        * Extracts a specific file and returns the content as string.
-        * Returns false if extraction failed.
-        * 
-        * @param       mixed           $index          index or name of the requested file
-        * @return      string                          content of the requested file
+       /** 
+        * @see wcf\system\io\IArchive::extractToString()
         */
        public function extractToString($index) {
                if (!$this->read) {
@@ -203,13 +188,8 @@ class Tar implements IArchive {
                return $content;
        }
        
-       /**
-        * Extracts a specific file and writes it's content
-        * to the file specified with $destination.
-        * 
-        * @param       mixed           $index          index or name of the requested file
-        * @param       string          $destination
-        * @return      boolean         $success
+       /** 
+        * @see wcf\system\io\IArchive::extract()
         */
        public function extract($index, $destination) {
                if (!$this->read) {