Merge pull request #274 from lcobucci/fix-documentation-of-internal-c…

…omponents

Fix documentation of internal components

src/Signer/BaseSigner.php

@@ -59,6 +59,8 @@ private function getKey($key)
     /**
      * Creates a hash with the given data
      *
+     * @internal
+     *
      * @param string $payload
      * @param Key $key
      *
@@ -67,7 +69,9 @@ private function getKey($key)
     abstract public function createHash($payload, Key $key);
 
     /**
-     * Creates a hash with the given data
+     * Performs the signature verification
+     *
+     * @internal
      *
      * @param string $expected
      * @param string $payload

src/Signer/Ecdsa.php

@@ -134,7 +134,9 @@ private function extractSignature($value)
     }
 
     /**
-     * Returns the lenght of signature parts
+     * Returns the length of signature parts
+     *
+     * @internal
      *
      * @return int
      */
@@ -143,6 +145,8 @@ abstract public function getSignatureLength();
     /**
      * Returns the name of algorithm to be used to create the signing hash
      *
+     * @internal
+     *
      * @return string
      */
     abstract public function getAlgorithm();

src/Signer/Ecdsa/KeyParser.php

@@ -20,6 +20,8 @@
 /**
  * Base class for ECDSA signers
  *
+ * @internal
+ *
  * @author Luís Otávio Cobucci Oblonczyk <[email protected]>
  * @since 3.0.4
  */

src/Signer/Hmac.php

@@ -40,6 +40,8 @@ public function doVerify($expected, $payload, Key $key)
     /**
      * PHP < 5.6 timing attack safe hash comparison
      *
+     * @internal
+     *
      * @param string $expected
      * @param string $generated
      *
@@ -65,6 +67,8 @@ public function hashEquals($expected, $generated)
     /**
      * Returns the algorithm name
      *
+     * @internal
+     *
      * @return string
      */
     abstract public function getAlgorithm();

src/Signer/Rsa.php

@@ -72,6 +72,8 @@ private function validateKey($key)
     /**
      * Returns the algorithm name
      *
+     * @internal
+     *
      * @return string
      */
     abstract public function getAlgorithm();