Update PHPDoc.

Badcow · Nov 30, 2020 · 52cd85f · 52cd85f
1 parent 94ecc1c
commit 52cd85f
Show file tree

Hide file tree

Showing 37 changed files with 23 additions and 359 deletions.
diff --git a/lib/Parser/ZoneFileFetcherInterface.php b/lib/Parser/ZoneFileFetcherInterface.php
@@ -21,9 +21,9 @@ interface ZoneFileFetcherInterface
     /**
      * Fetches the contents of a zone file with a given path.
      *
-     * @param string $path The path, relative or otherwise, to a zone file.
+     * @param string $path the path, relative or otherwise, to a zone file
      *
-     * @return string The text contents of the zone file.
+     * @return string the text contents of the zone file
      */
     public function fetch(string $path): string;
 }
diff --git a/lib/Rdata/A.php b/lib/Rdata/A.php
@@ -47,17 +47,12 @@ public function getAddress(): ?string
         return $this->address;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         return $this->address ?? '';
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws \InvalidArgumentException
      */
     public function toWire(): string
@@ -69,17 +64,12 @@ public function toWire(): string
         return $encoded;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $this->setAddress($text);
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws DecodeException
      */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void

diff --git a/lib/Rdata/AAAA.php b/lib/Rdata/AAAA.php
@@ -33,8 +33,6 @@ public function setAddress(string $address): void
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws DecodeException
      */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void

diff --git a/lib/Rdata/AFSDB.php b/lib/Rdata/AFSDB.php
@@ -53,8 +53,6 @@ public function setHostname(string $hostname): void
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws \InvalidArgumentException
      */
     public function toText(): string
@@ -70,17 +68,11 @@ public function toText(): string
         return sprintf('%d %s', $this->subType, $this->hostname);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toWire(): string
     {
         return pack('n', $this->subType).Message::encodeName($this->hostname);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $rdata = explode(' ', $text);
@@ -89,9 +81,6 @@ public function fromText(string $text): void
         $this->setHostname($rdata[1]);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $this->setSubType(unpack('n', $rdata, $offset)[1]);

diff --git a/lib/Rdata/APL.php b/lib/Rdata/APL.php
@@ -66,9 +66,6 @@ public function getExcludedAddressRanges(): array
         return $this->excludedAddressRanges;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         $string = '';
@@ -85,9 +82,6 @@ public function toText(): string
         return rtrim($string, ' ');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toWire(): string
     {
         $encoded = '';
@@ -112,8 +106,6 @@ public function toWire(): string
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws \Exception
      */
     public function fromText(string $text): void
@@ -132,9 +124,6 @@ public function fromText(string $text): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $end = $offset + ($rdLength ?? strlen($rdata));

diff --git a/lib/Rdata/CAA.php b/lib/Rdata/CAA.php
@@ -111,9 +111,6 @@ public function setValue(string $value): void
         $this->value = $value;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         if (!isset($this->tag) || !isset($this->flag) || !isset($this->value)) {
@@ -139,9 +136,6 @@ public function toWire(): string
             $this->value;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $this->setFlag(ord($rdata[$offset]));
@@ -159,9 +153,6 @@ public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null)
         $offset = $offset += $valueLen;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $rdata = explode(Tokens::SPACE, $text);

diff --git a/lib/Rdata/CERT.php b/lib/Rdata/CERT.php
@@ -141,9 +141,6 @@ public function getCertificate(): string
         return $this->certificate;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         $type = (array_key_exists($this->certificateType, self::MNEMONICS)) ? self::MNEMONICS[$this->certificateType] : (string) $this->certificateType;
@@ -152,17 +149,11 @@ public function toText(): string
         return sprintf('%s %s %s %s', $type, (string) $this->keyTag, $algorithm, base64_encode($this->certificate));
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toWire(): string
     {
         return pack('nnC', $this->certificateType, $this->keyTag, $this->algorithm).$this->certificate;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $rdata = explode(Tokens::SPACE, $text);
@@ -172,9 +163,6 @@ public function fromText(string $text): void
         $this->setCertificate(base64_decode(implode('', $rdata)));
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $integers = unpack('ntype/nkeyTag/Calgorithm', $rdata, $offset);

diff --git a/lib/Rdata/CNAME.php b/lib/Rdata/CNAME.php
@@ -43,17 +43,11 @@ public function getTarget(): ?string
         return $this->target;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         return $this->target ?? '';
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toWire(): string
     {
         if (null === $this->target) {
@@ -63,17 +57,11 @@ public function toWire(): string
         return Message::encodeName($this->target);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $this->setTarget($text);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $this->setTarget(Message::decodeName($rdata, $offset));

diff --git a/lib/Rdata/CSYNC.php b/lib/Rdata/CSYNC.php
@@ -78,27 +78,19 @@ public function setFlags(int $flags): void
         $this->flags = $flags;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         return sprintf('%d %d %s', $this->soaSerial, $this->flags, implode(Tokens::SPACE, $this->types));
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws UnsupportedTypeException
      */
     public function toWire(): string
     {
         return pack('Nn', $this->soaSerial, $this->flags).NSEC::renderBitmap($this->types);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $rdata = explode(Tokens::SPACE, $text);
@@ -108,8 +100,6 @@ public function fromText(string $text): void
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws UnsupportedTypeException|DecodeException
      */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void

diff --git a/lib/Rdata/DHCID.php b/lib/Rdata/DHCID.php
@@ -177,18 +177,13 @@ public function calculateDigest(): void
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws \BadMethodCallException
      */
     public function toText(): string
     {
         return base64_encode($this->toWire());
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toWire(): string
     {
         if (null === $this->digest) {
@@ -199,8 +194,6 @@ public function toWire(): string
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @throws \Exception
      */
     public function fromText(string $text): void
@@ -212,9 +205,6 @@ public function fromText(string $text): void
         $this->fromWire($decoded);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $rdLength = $rdLength ?? strlen($rdata);

diff --git a/lib/Rdata/DNSKEY.php b/lib/Rdata/DNSKEY.php
@@ -33,9 +33,6 @@ class DNSKEY extends KEY
      */
     protected $protocol = 3;
 
-    /**
-     * {@inheritdoc}
-     */
     public function setProtocol(int $protocol): void
     {
         if (3 !== $protocol) {

diff --git a/lib/Rdata/DS.php b/lib/Rdata/DS.php
@@ -111,9 +111,6 @@ public function calculateDigest(string $owner, DNSKEY $dnskey): void
         $this->digest = sha1(Message::encodeName(strtolower($owner)).$dnskey->toWire(), true);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         return sprintf(
@@ -125,17 +122,11 @@ public function toText(): string
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toWire(): string
     {
         return pack('nCC', $this->keyTag, $this->algorithm, $this->digestType).$this->digest;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $rdata = explode(Tokens::SPACE, $text);
@@ -148,9 +139,6 @@ public function fromText(string $text): void
         $this->setDigest($digest);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $digestLen = ($rdLength ?? strlen($rdata)) - 4;

diff --git a/lib/Rdata/HINFO.php b/lib/Rdata/HINFO.php
@@ -62,34 +62,22 @@ public function getOs(): ?string
         return $this->os;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toText(): string
     {
         return sprintf('"%s" "%s"', $this->cpu ?? '', $this->os ?? '');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toWire(): string
     {
         return $this->toText();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
     {
         $this->fromText(substr($rdata, $offset, $rdLength ?? strlen($rdata)));
         $offset += $rdLength;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function fromText(string $text): void
     {
         $string = new StringIterator($text);
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,8 +33,6 @@ public function setAddress(string $address): void @@
         }
         /**
-         * {@inheritdoc}
-         *
          * @throws DecodeException
          */
         public function fromWire(string $rdata, int &$offset = 0, ?int $rdLength = null): void
@@ Expand Down @@