QA: Fix @test references, APIdocs WS

Author: thekid

src/main/php/io/archive/zip/ZipArchiveReader.class.php

@@ -1,43 +1,45 @@
 <?php namespace io\archive\zip;
 
+use io\streams\{InputStream, Seekable};
+
 /**
  * Read from a zip file
  *
  * Usage in foreach
  * ----------------
- * <code>
- *   $z= ZipFile::open(new FileInputStream(new File('dist.zip')));
- *   foreach ($reader->entries() as $entry) {
- *     // ...
- *   }
- * </code>
+ * ```php
+ * $z= ZipFile::open(new FileInputStream(new File('dist.zip')));
+ * foreach ($reader->entries() as $entry) {
+ *   // ...
+ * }
+ * ```
  *
  * Usage with iterator
  * -------------------
- * <code>
- *   $z= ZipFile::open(new FileInputStream(new File('dist.zip')));
- *   $it= $z->iterator();
- *   while ($it->hasNext()) {
- *     $entry= $it->next();
- *     // ...
- *   }
- * </code>
+ * ```php
+ * $z= ZipFile::open(new FileInputStream(new File('dist.zip')));
+ * $it= $z->iterator();
+ * while ($it->hasNext()) {
+ *   $entry= $it->next();
+ *   // ...
+ * }
+ * ```
  *
- * @test    xp://net.xp_framework.unittest.io.archive.ZipArchiveReaderTest
- * @test    xp://net.xp_framework.unittest.io.archive.ZipFileEntriesTest
- * @test    xp://net.xp_framework.unittest.io.archive.ZipFileIteratorTest
- * @see     xp://io.archive.zip.ZipArchive#open
+ * @test  io.archive.zip.unittest.ZipArchiveReaderTest
+ * @test  io.archive.zip.unittest.ZipFileEntriesTest
+ * @test  io.archive.zip.unittest.ZipFileIteratorTest
+ * @see   io.archive.zip.ZipArchive#open
  */
 class ZipArchiveReader {
   protected $impl= NULL;
 
   /**
    * Creation constructor
    *
-   * @param   io.streams.InputStream stream
+   * @param  io.streams.InputStream $stream
    */
-  public function __construct(\io\streams\InputStream $stream) {
-    if ($stream instanceof \io\streams\Seekable) {
+  public function __construct(InputStream $stream) {
+    if ($stream instanceof Seekable) {
       $this->impl= new RandomAccessZipReaderImpl($stream);
     } else {
       $this->impl= new SequentialZipReaderImpl($stream);
@@ -47,8 +49,8 @@ public function __construct(\io\streams\InputStream $stream) {
   /**
    * Set password to use when extracting 
    *
-   * @param   string password
-   * @return  io.archive.zip.ZipArchiveReader this
+   * @param  string $password
+   * @return self
    */
   public function usingPassword($password) {
     $this->impl->setPassword($password);
@@ -58,7 +60,7 @@ public function usingPassword($password) {
   /**
    * Returns a list of all entries in this zip file
    *
-   * @return  io.archive.zip.ZipEntries
+   * @return io.archive.zip.ZipEntries
    */
   public function entries() {
     return new ZipEntries($this->impl);
@@ -67,14 +69,16 @@ public function entries() {
   /**
    * Returns an iterator of all entries in this zip file
    *
-   * @return  io.archive.zip.ZipIterator
+   * @return io.archive.zip.ZipIterator
    */
   public function iterator() {
     return new ZipIterator($this->impl);
   }
 
   /**
    * Closes underlying stream
+   *
+   * @return void
    */
   public function close() {
     $this->impl->close();

src/main/php/io/archive/zip/ZipFile.class.php

@@ -7,7 +7,7 @@
  * Zip archives hanadling
  *
  * Usage (creating a zip file)
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * ---------------------------
  * ```php
  * $z= ZipFile::create(new FileOutputStream(new File('dist.zip')));
  * $dir= $z->add(new ZipDirEntry('META-INF'));
@@ -17,7 +17,7 @@
  * ```
  *
  * Usage (reading a zip file)
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * --------------------------
  * ```php
  * $z= ZipFile::open(new FileInputStream(new File('dist.zip')));
  * foreach ($z->entries() as $entry) {