update docs

Author: nejcdev

src/Abstract/AbstractBigInteger.php

@@ -14,21 +14,31 @@
  *
  * @package Nejcc\PhpDatatypes\Integers
  */
-abstract class AbstractBigInteger implements BigIntegerInterface, NativeIntegerInterface
+abstract class AbstractBigInteger implements BigIntegerInterface
 {
  use ArithmeticOperationsTrait;
  use IntegerComparisonTrait;
 
+ /**
+ * @var string
+ */
  protected readonly string $value;
 
  public const MIN_VALUE = null;
  public const MAX_VALUE = null;
 
+ /**
+ * @param int|string $value
+ */
  public function __construct(int|string $value)
  {
  $this->setValue($value);
  }
 
+ /**
+ * @param int|string $value
+ * @return void
+ */
  protected function setValue(int|string $value): void
  {
  $valueStr = (string)$value;
@@ -44,18 +54,30 @@ protected function setValue(int|string $value): void
  $this->value = $valueStr;
  }
 
+ /**
+ * @return string
+ */
  public function getValue(): string
  {
  return $this->value;
  }
 
- // Implement comparison method
+ /**
+ * @param NativeIntegerInterface|BigIntegerInterface $other
+ * @return int
+ */
  public function compare(NativeIntegerInterface|BigIntegerInterface $other): int
  {
  return bccomp($this->value, (string)$other->getValue());
  }
 
- // Implement operation methods required by the trait
+
+ /**
+ * @param BigIntegerInterface|NativeIntegerInterface $other
+ * @param callable $operation
+ * @param string $operationName
+ * @return $this
+ */
  protected function performOperation(
  BigIntegerInterface|NativeIntegerInterface $other,
  callable $operation,
@@ -71,21 +93,41 @@ protected function performOperation(
  return new static($result);
  }
 
+ /**
+ * @param string $a
+ * @param string $b
+ * @return string
+ */
  protected function addValues(string $a, string $b): string
  {
  return bcadd($a, $b, 0);
  }
 
+ /**
+ * @param string $a
+ * @param string $b
+ * @return string
+ */
  protected function subtractValues(string $a, string $b): string
  {
  return bcsub($a, $b, 0);
  }
 
+ /**
+ * @param string $a
+ * @param string $b
+ * @return string
+ */
  protected function multiplyValues(string $a, string $b): string
  {
  return bcmul($a, $b, 0);
  }
 
+ /**
+ * @param string $a
+ * @param string $b
+ * @return string
+ */
  protected function divideValues(string $a, string $b): string
  {
  if ($b === '0') {
@@ -101,6 +143,11 @@ protected function divideValues(string $a, string $b): string
  return $result;
  }
 
+ /**
+ * @param string $a
+ * @param string $b
+ * @return string
+ */
  protected function modValues(string $a, string $b): string
  {
  if ($b === '0') {

src/Abstract/AbstractFloat.php

@@ -8,16 +8,26 @@
 
 abstract class AbstractFloat
 {
+ /**
+ * @var float
+ */
  protected readonly float $value;
 
  public const MIN_VALUE = null;
  public const MAX_VALUE = null;
 
+ /**
+ * @param float $value
+ */
  public function __construct(float $value)
  {
  $this->setValue($value);
  }
 
+ /**
+ * @param float $value
+ * @return void
+ */
  protected function setValue(float $value): void
  {
  // Check if value is out of range
@@ -33,6 +43,9 @@ protected function setValue(float $value): void
  $this->value = $value;
  }
 
+ /**
+ * @return float
+ */
  public function getValue(): float
  {
  return $this->value;

src/Abstract/AbstractNativeInteger.php

@@ -23,11 +23,18 @@ abstract class AbstractNativeInteger implements NativeIntegerInterface
  public const MIN_VALUE = null;
  public const MAX_VALUE = null;
 
+ /**
+ * @param int $value
+ */
  public function __construct(int $value)
  {
  $this->setValue($value);
  }
 
+ /**
+ * @param int $value
+ * @return void
+ */
  protected function setValue(int $value): void
  {
  if ($value < static::MIN_VALUE || $value > static::MAX_VALUE) {
@@ -41,16 +48,29 @@ protected function setValue(int $value): void
  $this->value = $value;
  }
 
+ /**
+ * @return int
+ */
  public function getValue(): int
  {
  return $this->value;
  }
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return int
+ */
  public function compare(NativeIntegerInterface $other): int
  {
  return $this->value <=> $other->getValue();
  }
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @param callable $operation
+ * @param string $operationName
+ * @return $this
+ */
  protected function performOperation(
  NativeIntegerInterface $other,
  callable $operation,
@@ -66,21 +86,41 @@ protected function performOperation(
  return new static($result);
  }
 
+ /**
+ * @param int $a
+ * @param int $b
+ * @return int
+ */
  protected function addValues(int $a, int $b): int
  {
  return $a + $b;
  }
 
+ /**
+ * @param int $a
+ * @param int $b
+ * @return int
+ */
  protected function subtractValues(int $a, int $b): int
  {
  return $a - $b;
  }
 
+ /**
+ * @param int $a
+ * @param int $b
+ * @return int
+ */
  protected function multiplyValues(int $a, int $b): int
  {
  return $a * $b;
  }
 
+ /**
+ * @param int $a
+ * @param int $b
+ * @return int
+ */
  protected function divideValues(int $a, int $b): int
  {
  if ($b === 0) {
@@ -94,6 +134,11 @@ protected function divideValues(int $a, int $b): int
  return intdiv($a, $b);
  }
 
+ /**
+ * @param int $a
+ * @param int $b
+ * @return int
+ */
  protected function modValues(int $a, int $b): int
  {
  if ($b === 0) {

src/Integers/Signed/Int32.php

@@ -26,6 +26,4 @@ final class Int32 extends AbstractNativeInteger
  * @var int
  */
  public const MAX_VALUE = 2147483647;
-
- // Inherit methods from AbstractInteger.
 }

src/Interfaces/BigIntegerInterface.php

@@ -11,19 +11,50 @@
  */
 interface BigIntegerInterface
 {
+ /**
+ * @return string
+ */
  public function getValue(): string;
 
+ /**
+ * @param BigIntegerInterface $other
+ * @return $this
+ */
  public function add(BigIntegerInterface $other): static;
 
+ /**
+ * @param BigIntegerInterface $other
+ * @return $this
+ */
  public function subtract(BigIntegerInterface $other): static;
 
+ /**
+ * @param BigIntegerInterface $other
+ * @return $this
+ */
  public function multiply(BigIntegerInterface $other): static;
 
+ /**
+ * @param BigIntegerInterface $other
+ * @return $this
+ */
  public function divide(BigIntegerInterface $other): static;
 
+ /**
+ * @param BigIntegerInterface $other
+ * @return $this
+ */
  public function mod(BigIntegerInterface $other): static;
 
+ /**
+ * @param BigIntegerInterface $other
+ * @return bool
+ */
  public function equals(BigIntegerInterface $other): bool;
 
+ /**
+ * @param BigIntegerInterface $other
+ * @return int
+ */
  public function compare(BigIntegerInterface $other): int;
 }

src/Interfaces/FloatInterface.php

@@ -4,6 +4,8 @@
 
 interface FloatInterface
 {
+ /**
+ * @return float
+ */
  public function getValue(): float;
-
 }

src/Interfaces/NativeIntegerInterface.php

@@ -11,19 +11,50 @@
  */
 interface NativeIntegerInterface
 {
+ /**
+ * @return int
+ */
  public function getValue(): int;
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return $this
+ */
  public function add(NativeIntegerInterface $other): static;
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return $this
+ */
  public function subtract(NativeIntegerInterface $other): static;
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return $this
+ */
  public function multiply(NativeIntegerInterface $other): static;
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return $this
+ */
  public function divide(NativeIntegerInterface $other): static;
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return $this
+ */
  public function mod(NativeIntegerInterface $other): static;
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return bool
+ */
  public function equals(NativeIntegerInterface $other): bool;
 
+ /**
+ * @param NativeIntegerInterface $other
+ * @return int
+ */
  public function compare(NativeIntegerInterface $other): int;
 }