Fix docblocks

This commit is contained in:
Dennis Eichhorn 2018-12-08 21:49:02 +01:00
parent 92374d311f
commit b8f375480d
4 changed files with 47 additions and 7 deletions

View File

@ -41,7 +41,14 @@ class Caesar
public const LIMIT_UPPER = 127; 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 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 public static function decode(string $raw, string $key) : string
{ {

View File

@ -38,7 +38,7 @@ interface EncodingInterface
/** /**
* Dedecodes text * Dedecodes text
* *
* @param string $decoded decoded text to dedecode * @param string $decoded encoded text to dedecode
* *
* @return string * @return string
* *

View File

@ -25,7 +25,13 @@ namespace phpOMS\Utils\Encoding;
final class Gray 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 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 public static function decode(int $gray) : int
{ {

View File

@ -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 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 public static function encode(string $source, string $key) : string
{ {