From b8f375480d5e2ed63a3880b88ccd77803241fa31 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Sat, 8 Dec 2018 21:49:02 +0100 Subject: [PATCH] Fix docblocks --- Utils/Encoding/Caesar.php | 18 ++++++++++++++++-- Utils/Encoding/EncodingInterface.php | 2 +- Utils/Encoding/Gray.php | 16 ++++++++++++++-- Utils/Encoding/XorEncoding.php | 18 ++++++++++++++++-- 4 files changed, 47 insertions(+), 7 deletions(-) diff --git a/Utils/Encoding/Caesar.php b/Utils/Encoding/Caesar.php index c251791e6..768e8d87f 100644 --- a/Utils/Encoding/Caesar.php +++ b/Utils/Encoding/Caesar.php @@ -41,7 +41,14 @@ class Caesar public const LIMIT_UPPER = 127; /** - * {@inheritdoc} + * Encode source text + * + * @param string $source Source to encode + * @param string $key Key used for encoding + * + * @return string + * + * @since 1.0.0 */ public static function encode(string $source, string $key) : string { @@ -67,7 +74,14 @@ class Caesar } /** - * {@inheritdoc} + * Decode text + * + * @param string $raw Source to encode + * @param string $key Key used for decoding + * + * @return string + * + * @since 1.0.0 */ public static function decode(string $raw, string $key) : string { diff --git a/Utils/Encoding/EncodingInterface.php b/Utils/Encoding/EncodingInterface.php index 9dea26af3..e8526f3b2 100644 --- a/Utils/Encoding/EncodingInterface.php +++ b/Utils/Encoding/EncodingInterface.php @@ -38,7 +38,7 @@ interface EncodingInterface /** * Dedecodes text * - * @param string $decoded decoded text to dedecode + * @param string $decoded encoded text to dedecode * * @return string * diff --git a/Utils/Encoding/Gray.php b/Utils/Encoding/Gray.php index 7e48a6348..d7d051c1d 100644 --- a/Utils/Encoding/Gray.php +++ b/Utils/Encoding/Gray.php @@ -25,7 +25,13 @@ namespace phpOMS\Utils\Encoding; final class Gray { /** - * {@inheritdoc} + * Encode source text + * + * @param int $source Source to encode + * + * @return int + * + * @since 1.0.0 */ public static function encode(int $source) : int { @@ -33,7 +39,13 @@ final class Gray } /** - * {@inheritdoc} + * Dedecodes text + * + * @param int $gray encoded value to dedecode + * + * @return int + * + * @since 1.0.0 */ public static function decode(int $gray) : int { diff --git a/Utils/Encoding/XorEncoding.php b/Utils/Encoding/XorEncoding.php index 6d1098483..4c5093d40 100644 --- a/Utils/Encoding/XorEncoding.php +++ b/Utils/Encoding/XorEncoding.php @@ -26,7 +26,14 @@ final class XorEncoding { /** - * {@inheritdoc} + * Decode text + * + * @param string $raw Source to encode + * @param string $key Key used for decoding + * + * @return string + * + * @since 1.0.0 */ public static function decode(string $raw, string $key) : string { @@ -34,7 +41,14 @@ final class XorEncoding } /** - * {@inheritdoc} + * Encode source text + * + * @param string $source Source to encode + * @param string $key Key used for encoding + * + * @return string + * + * @since 1.0.0 */ public static function encode(string $source, string $key) : string {