Add missing doc blocks

Intervention · Aug 11, 2024 · 54aa51e · 54aa51e
1 parent 706ca2c
commit 54aa51e
Show file tree

Hide file tree

Showing 90 changed files with 532 additions and 0 deletions.
diff --git a/src/Colors/Hsl/Color.php b/src/Colors/Hsl/Color.php
@@ -16,6 +16,14 @@
 
 class Color extends AbstractColor
 {
+    /**
+     * Create new color object
+     *
+     * @param int $h
+     * @param int $s
+     * @param int $l
+     * @return void
+     */
     public function __construct(int $h, int $s, int $l)
     {
         /** @throws void */

diff --git a/src/Colors/Hsv/Color.php b/src/Colors/Hsv/Color.php
@@ -16,6 +16,14 @@
 
 class Color extends AbstractColor
 {
+    /**
+     * Create new color object
+     *
+     * @param int $h
+     * @param int $s
+     * @param int $v
+     * @return void
+     */
     public function __construct(int $h, int $s, int $v)
     {
         /** @throws void */

diff --git a/src/Colors/Rgb/Decoders/TransparentColorDecoder.php b/src/Colors/Rgb/Decoders/TransparentColorDecoder.php
@@ -10,6 +10,11 @@
 
 class TransparentColorDecoder extends HexColorDecoder
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
     public function decode(mixed $input): ImageInterface|ColorInterface
     {
         if (!is_string($input)) {

diff --git a/src/Drivers/Gd/Analyzers/ColorspaceAnalyzer.php b/src/Drivers/Gd/Analyzers/ColorspaceAnalyzer.php
@@ -11,6 +11,11 @@
 
 class ColorspaceAnalyzer extends GenericColorspaceAnalyzer implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see AnalyzerInterface::analyze()
+     */
     public function analyze(ImageInterface $image): mixed
     {
         return new Colorspace();

diff --git a/src/Drivers/Gd/Analyzers/HeightAnalyzer.php b/src/Drivers/Gd/Analyzers/HeightAnalyzer.php
@@ -10,6 +10,11 @@
 
 class HeightAnalyzer extends GenericHeightAnalyzer implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see AnalyzerInterface::analyze()
+     */
     public function analyze(ImageInterface $image): mixed
     {
         return imagesy($image->core()->native());

diff --git a/src/Drivers/Gd/Analyzers/PixelColorAnalyzer.php b/src/Drivers/Gd/Analyzers/PixelColorAnalyzer.php
@@ -15,6 +15,11 @@
 
 class PixelColorAnalyzer extends GenericPixelColorAnalyzer implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see AnalyzerInterface::analyze()
+     */
     public function analyze(ImageInterface $image): mixed
     {
         return $this->colorAt(

diff --git a/src/Drivers/Gd/Analyzers/PixelColorsAnalyzer.php b/src/Drivers/Gd/Analyzers/PixelColorsAnalyzer.php
@@ -9,6 +9,11 @@
 
 class PixelColorsAnalyzer extends PixelColorAnalyzer
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see AnalyzerInterface::analyze()
+     */
     public function analyze(ImageInterface $image): mixed
     {
         $colors = new Collection();

diff --git a/src/Drivers/Gd/Analyzers/ResolutionAnalyzer.php b/src/Drivers/Gd/Analyzers/ResolutionAnalyzer.php
@@ -11,6 +11,11 @@
 
 class ResolutionAnalyzer extends GenericResolutionAnalyzer implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see AnalyzerInterface::analyze()
+     */
     public function analyze(ImageInterface $image): mixed
     {
         return new Resolution(...imageresolution($image->core()->native()));

diff --git a/src/Drivers/Gd/Analyzers/WidthAnalyzer.php b/src/Drivers/Gd/Analyzers/WidthAnalyzer.php
@@ -10,6 +10,11 @@
 
 class WidthAnalyzer extends GenericWidthAnalyzer implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see AnalyzerInterface::analyze()
+     */
     public function analyze(ImageInterface $image): mixed
     {
         return imagesx($image->core()->native());

diff --git a/src/Drivers/Gd/ColorProcessor.php b/src/Drivers/Gd/ColorProcessor.php
@@ -17,10 +17,21 @@
 
 class ColorProcessor implements ColorProcessorInterface
 {
+    /**
+     * Create new color processor object
+     *
+     * @param ColorspaceInterface $colorspace
+     * @return void
+     */
     public function __construct(protected ColorspaceInterface $colorspace = new Colorspace())
     {
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @see ColorProcessorInterface::colorToNative()
+     */
     public function colorToNative(ColorInterface $color): int
     {
         // convert color to colorspace
@@ -39,6 +50,11 @@ public function colorToNative(ColorInterface $color): int
         return ($a << 24) + ($r << 16) + ($g << 8) + $b;
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @see ColorProcessorInterface::nativeToColor()
+     */
     public function nativeToColor(mixed $value): ColorInterface
     {
         if (!is_int($value)) {

diff --git a/src/Drivers/Gd/Decoders/Base64ImageDecoder.php b/src/Drivers/Gd/Decoders/Base64ImageDecoder.php
@@ -11,6 +11,11 @@
 
 class Base64ImageDecoder extends BinaryImageDecoder implements DecoderInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
     public function decode(mixed $input): ImageInterface|ColorInterface
     {
         if (!$this->isValidBase64($input)) {

diff --git a/src/Drivers/Gd/Decoders/DataUriImageDecoder.php b/src/Drivers/Gd/Decoders/DataUriImageDecoder.php
@@ -11,6 +11,11 @@
 
 class DataUriImageDecoder extends BinaryImageDecoder implements DecoderInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
     public function decode(mixed $input): ImageInterface|ColorInterface
     {
         if (!is_string($input)) {

diff --git a/src/Drivers/Gd/Decoders/FilePathImageDecoder.php b/src/Drivers/Gd/Decoders/FilePathImageDecoder.php
@@ -13,6 +13,11 @@
 
 class FilePathImageDecoder extends NativeObjectDecoder implements DecoderInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
     public function decode(mixed $input): ImageInterface|ColorInterface
     {
         if (!$this->isFile($input)) {

diff --git a/src/Drivers/Gd/Decoders/FilePointerImageDecoder.php b/src/Drivers/Gd/Decoders/FilePointerImageDecoder.php
@@ -10,6 +10,11 @@
 
 class FilePointerImageDecoder extends BinaryImageDecoder
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
     public function decode(mixed $input): ImageInterface|ColorInterface
     {
         if (!is_resource($input) || !in_array(get_resource_type($input), ['file', 'stream'])) {

diff --git a/src/Drivers/Gd/Decoders/SplFileInfoImageDecoder.php b/src/Drivers/Gd/Decoders/SplFileInfoImageDecoder.php
@@ -12,6 +12,11 @@
 
 class SplFileInfoImageDecoder extends FilePathImageDecoder implements DecoderInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see DecoderInterface::decode()
+     */
     public function decode(mixed $input): ImageInterface|ColorInterface
     {
         if (!is_a($input, SplFileInfo::class)) {

diff --git a/src/Drivers/Gd/Encoders/AvifEncoder.php b/src/Drivers/Gd/Encoders/AvifEncoder.php
@@ -11,6 +11,11 @@
 
 class AvifEncoder extends GenericAvifEncoder implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see EncoderInterface::encode()
+     */
     public function encode(ImageInterface $image): EncodedImage
     {
         $gd = $image->core()->native();

diff --git a/src/Drivers/Gd/Encoders/BmpEncoder.php b/src/Drivers/Gd/Encoders/BmpEncoder.php
@@ -11,6 +11,11 @@
 
 class BmpEncoder extends GenericBmpEncoder implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see EncoderInterface::encode()
+     */
     public function encode(ImageInterface $image): EncodedImage
     {
         $data = $this->buffered(function () use ($image) {

diff --git a/src/Drivers/Gd/Encoders/GifEncoder.php b/src/Drivers/Gd/Encoders/GifEncoder.php
@@ -15,6 +15,11 @@
 
 class GifEncoder extends GenericGifEncoder implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see EncoderInterface::encode()
+     */
     public function encode(ImageInterface $image): EncodedImage
     {
         if ($image->isAnimated()) {

diff --git a/src/Drivers/Gd/Encoders/JpegEncoder.php b/src/Drivers/Gd/Encoders/JpegEncoder.php
@@ -12,6 +12,11 @@
 
 class JpegEncoder extends GenericJpegEncoder implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see EncoderInterface::encode()
+     */
     public function encode(ImageInterface $image): EncodedImage
     {
         $blendingColor = $this->driver()->handleInput(

diff --git a/src/Drivers/Gd/Encoders/WebpEncoder.php b/src/Drivers/Gd/Encoders/WebpEncoder.php
@@ -11,6 +11,11 @@
 
 class WebpEncoder extends GenericWebpEncoder implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see EncoderInterface::encode()
+     */
     public function encode(ImageInterface $image): EncodedImage
     {
         $quality = $this->quality === 100 ? IMG_WEBP_LOSSLESS : $this->quality;

diff --git a/src/Drivers/Gd/Modifiers/AlignRotationModifier.php b/src/Drivers/Gd/Modifiers/AlignRotationModifier.php
@@ -10,6 +10,11 @@
 
 class AlignRotationModifier extends GenericAlignRotationModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         $image = match ($image->exif('IFD0.Orientation')) {

diff --git a/src/Drivers/Gd/Modifiers/BlendTransparencyModifier.php b/src/Drivers/Gd/Modifiers/BlendTransparencyModifier.php
@@ -11,6 +11,11 @@
 
 class BlendTransparencyModifier extends GenericBlendTransparencyModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         // decode blending color

diff --git a/src/Drivers/Gd/Modifiers/BlurModifier.php b/src/Drivers/Gd/Modifiers/BlurModifier.php
@@ -10,6 +10,11 @@
 
 class BlurModifier extends GenericBlurModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         foreach ($image as $frame) {

diff --git a/src/Drivers/Gd/Modifiers/BrightnessModifier.php b/src/Drivers/Gd/Modifiers/BrightnessModifier.php
@@ -10,6 +10,11 @@
 
 class BrightnessModifier extends GenericBrightnessModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         foreach ($image as $frame) {

diff --git a/src/Drivers/Gd/Modifiers/ColorizeModifier.php b/src/Drivers/Gd/Modifiers/ColorizeModifier.php
@@ -10,6 +10,11 @@
 
 class ColorizeModifier extends GenericColorizeModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         // normalize colorize levels

diff --git a/src/Drivers/Gd/Modifiers/ColorspaceModifier.php b/src/Drivers/Gd/Modifiers/ColorspaceModifier.php
@@ -12,6 +12,11 @@
 
 class ColorspaceModifier extends GenericColorspaceModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         if (!is_a($this->targetColorspace(), RgbColorspace::class)) {

diff --git a/src/Drivers/Gd/Modifiers/ContainModifier.php b/src/Drivers/Gd/Modifiers/ContainModifier.php
@@ -18,6 +18,11 @@
 
 class ContainModifier extends GenericContainModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         $crop = $this->getCropSize($image);

diff --git a/src/Drivers/Gd/Modifiers/ContrastModifier.php b/src/Drivers/Gd/Modifiers/ContrastModifier.php
@@ -10,6 +10,11 @@
 
 class ContrastModifier extends GenericContrastModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         foreach ($image as $frame) {

diff --git a/src/Drivers/Gd/Modifiers/CoverModifier.php b/src/Drivers/Gd/Modifiers/CoverModifier.php
@@ -14,6 +14,11 @@
 
 class CoverModifier extends GenericCoverModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         $crop = $this->getCropSize($image);

diff --git a/src/Drivers/Gd/Modifiers/CropModifier.php b/src/Drivers/Gd/Modifiers/CropModifier.php
@@ -14,6 +14,11 @@
 
 class CropModifier extends GenericCropModifier implements SpecializedInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
+     */
     public function apply(ImageInterface $image): ImageInterface
     {
         $originalSize = $image->size();

diff --git a/src/Drivers/Gd/Modifiers/DrawBezierModifier.php b/src/Drivers/Gd/Modifiers/DrawBezierModifier.php
@@ -13,6 +13,9 @@
 class DrawBezierModifier extends ModifiersDrawBezierModifier implements SpecializedInterface
 {
     /**
+     * {@inheritdoc}
+     *
+     * @see ModifierInterface::apply()
      * @throws RuntimeException
      * @throws GeometryException
      */