QA: APIdoc whitespace / references consistency

Author: thekid

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

@@ -5,7 +5,7 @@
 /**
  * Output stream for files
  *
- * @see xp://io.archive.zip.ZipArchiveWriter#addFile
+ * @see io.archive.zip.ZipArchiveWriter::addFile
  */
 class CipheringZipFileOutputStream implements OutputStream {
  protected $writer, $file, $name, $md, $cipher;

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

@@ -35,11 +35,10 @@
  *
  * This implementation supports 0 (NONE), 8 (GZ) and 12 (BZIP2).
  *
- * @ext bz2
- * @ext zlib
- * @see xp://io.archive.zip.ZipArchive
- * @test xp://net.xp_framework.unittest.io.archive.CompressionTest
- * @purpose Compressions
+ * @ext bz2
+ * @ext zlib
+ * @see io.archive.zip.ZipArchive
+ * @test io.archive.zip.unittest.CompressionTest
  */
 abstract class Compression extends Enum {
  public static $NONE, $GZ, $BZ;
@@ -101,7 +100,7 @@ public abstract function getDecompressionStream(InputStream $in);
  /**
  * Get a compression instance by a given id
  *
- * @param int n
+ * @param int $n
  * @return io.archive.zip.Compression
  * @throws lang.IllegalArgumentException
  */

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

@@ -5,7 +5,7 @@
 /**
  * Deciphers using ZipCipher class
  *
- * @see xp://io.archive.zip.ZipCipher
+ * @see io.archive.zip.ZipCipher
  */
 class DecipheringInputStream implements InputStream {
  protected $in= null;

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

@@ -3,16 +3,13 @@
 use io\streams\{InputStream, Seekable};
 use lang\FormatException;
 
-/**
- * Zip archive reader that works on Seekable input streams.
- *
- */
+/** Zip archive reader that works on Seekable input streams. */
 class RandomAccessZipReaderImpl extends AbstractZipReaderImpl {
 
  /**
  * Creation constructor
  *
- * @param  io.streams.InputStream stream
+ * @param io.streams.InputStream $stream
  */
  public function __construct(InputStream $stream) {
  parent::__construct(cast($stream, 'io.streams.Seekable'));
@@ -21,7 +18,7 @@ public function __construct(InputStream $stream) {
  /**
  * Get first entry
  *
- * @return  io.archive.zip.ZipEntry
+ * @return io.archive.zip.ZipEntry
  */
  public function firstEntry() {
  $this->streamPosition(0);
@@ -31,7 +28,7 @@ public function firstEntry() {
  /**
  * Get next entry
  *
- * @return  io.archive.zip.ZipEntry
+ * @return io.archive.zip.ZipEntry
  */
  public function nextEntry() {
  $this->skip && $this->streamPosition($this->position + $this->skip);
@@ -41,8 +38,8 @@ public function nextEntry() {
  /**
  * Seeks a stream
  *
- * @param  int offset absolute offset
- * @param  int whence
+ * @param int $offset absolute offset
+ * @param int $whence
  */
  protected function streamSeek($offset, $whence) {
  $this->stream->seek($offset, $whence);
@@ -51,6 +48,7 @@ protected function streamSeek($offset, $whence) {
  /**
  * Read central directory
  *
+ * @return void
  */
  protected function readCentralDirectory() {
  $entries= $this->seekCentralDirectory();
@@ -102,7 +100,7 @@ protected function seekCentralDirectory() {
  $marker= substr($marker, -3);
  }
 
- if (0 == $this->streamAvailable()) {
+ if (0 === $this->streamAvailable()) {
  throw new FormatException('Could not find central directory; currently not supporting archives w/ file comments.');
  }
 

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

@@ -3,10 +3,7 @@
 use io\streams\Seekable;
 use lang\{IllegalArgumentException, IllegalStateException};
 
-/**
- * Zip archive reader that works on any input stream.
- *
- */
+/** Zip archive reader that works on any input stream */
 class SequentialZipReaderImpl extends AbstractZipReaderImpl {
  private $initial= true;
 

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

@@ -26,7 +26,7 @@
  * }
  * ```
  *
- * @see io.archive.zip.ZipArchive#open
+ * @see io.archive.zip.ZipArchive::open
  * @test io.archive.zip.unittest.ZipArchiveReaderTest
  * @test io.archive.zip.unittest.ZipFileEntriesTest
  * @test io.archive.zip.unittest.ZipFileIteratorTest

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

@@ -5,8 +5,8 @@
 /**
  * Zip Cipher.
  *
- * @test  xp://net.xp_framework.unittest.io.archive.vendors.SevenZipFileTest
- * @see  http://www.pkware.com/documents/casestudies/APPNOTE.TXT
+ * @test io.archive.zip.unittest.vendors.SevenZipFileTest
+ * @see http://www.pkware.com/documents/casestudies/APPNOTE.TXT
  */
 class ZipCipher {
  protected $keys= null;

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

@@ -5,7 +5,7 @@
 /**
  * Represents a Dir entry in a zip archive
  *
- * @test net.xp_framework.unittest.io.archive.ZipEntryTest
+ * @test io.archive.zip.unittest.ZipEntryTest
  * @see io.archive.zip.ZipEntry
  */
 class ZipDirEntry implements ZipEntry {

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

@@ -5,7 +5,7 @@
 /**
  * Iterates on ZIP archive entries
  *
- * @test  xp://net.xp_framework.unittest.io.archive.ZipFileEntriesTest
+ * @test io.archive.zip.unittest.ZipFileEntriesTest
  */
 class ZipEntries implements Iterator {
  protected $impl= null;

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

@@ -5,7 +5,7 @@
 /**
  * Represents an entry in a zip archive
  *
- * @see  xp://io.archive.zip.ZipArchive
+ * @see io.archive.zip.ZipArchive
  */
 interface ZipEntry {