From 67ea562983e79687c53f04617638f8089a7c125f Mon Sep 17 00:00:00 2001 From: flashwave Date: Wed, 2 Oct 2024 19:41:33 +0000 Subject: [PATCH] Replaced @internal docs. --- TODO.md | 2 -- VERSION | 2 +- src/Colour/Colour.php | 4 +++- src/Data/MariaDb/MariaDbBackend.php | 5 ++++- src/Data/MariaDb/MariaDbResultLib.php | 2 -- src/Data/MariaDb/MariaDbResultNative.php | 2 -- src/Data/MariaDb/MariaDbStatement.php | 2 -- src/Http/Routing/HttpRouter.php | 2 +- 8 files changed, 9 insertions(+), 12 deletions(-) diff --git a/TODO.md b/TODO.md index 890de2b..19f84dd 100644 --- a/TODO.md +++ b/TODO.md @@ -18,5 +18,3 @@ - Get guides working on phpdoc. - Create phpdoc template. - - - Review all constructors and see which one should be marked @internal. diff --git a/VERSION b/VERSION index a1be6dd..199aff6 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.2410.21928 +0.2410.21941 diff --git a/src/Colour/Colour.php b/src/Colour/Colour.php index 580e131..94b55cb 100644 --- a/src/Colour/Colour.php +++ b/src/Colour/Colour.php @@ -303,7 +303,9 @@ abstract class Colour implements Stringable { return self::$none; } - /** @internal */ + /** + * Initialises the Colour class. + */ public static function init(): void { self::$none = new ColourNull; } diff --git a/src/Data/MariaDb/MariaDbBackend.php b/src/Data/MariaDb/MariaDbBackend.php index 517c38f..6ece5b1 100644 --- a/src/Data/MariaDb/MariaDbBackend.php +++ b/src/Data/MariaDb/MariaDbBackend.php @@ -18,7 +18,10 @@ class MariaDbBackend implements DbBackend { } /** - * @internal + * Formats a MySQL integer version as a string. + * + * @param int $version MySQL version number. + * @return string */ public static function intToVersion(int $version): string { $sub = $version % 100; diff --git a/src/Data/MariaDb/MariaDbResultLib.php b/src/Data/MariaDb/MariaDbResultLib.php index d46c932..457194b 100644 --- a/src/Data/MariaDb/MariaDbResultLib.php +++ b/src/Data/MariaDb/MariaDbResultLib.php @@ -10,8 +10,6 @@ use RuntimeException; /** * Implementation of MariaDbResult for libmysql. - * - * @internal */ class MariaDbResultLib extends MariaDbResult { /** @var mixed[] */ diff --git a/src/Data/MariaDb/MariaDbResultNative.php b/src/Data/MariaDb/MariaDbResultNative.php index 41506d7..f70b89b 100644 --- a/src/Data/MariaDb/MariaDbResultNative.php +++ b/src/Data/MariaDb/MariaDbResultNative.php @@ -11,8 +11,6 @@ use RuntimeException; /** * Implementation of MariaDbResult for mysqlnd. - * - * @internal */ class MariaDbResultNative extends MariaDbResult { public function __construct(mysqli_stmt|mysqli_result $result) { diff --git a/src/Data/MariaDb/MariaDbStatement.php b/src/Data/MariaDb/MariaDbStatement.php index f7ba462..1bb0b6b 100644 --- a/src/Data/MariaDb/MariaDbStatement.php +++ b/src/Data/MariaDb/MariaDbStatement.php @@ -35,8 +35,6 @@ class MariaDbStatement implements DbStatement { /** * Determines which MariaDbResult implementation should be used. - * - * @internal */ public static function construct(): void { if(self::$constructed !== false) diff --git a/src/Http/Routing/HttpRouter.php b/src/Http/Routing/HttpRouter.php index b63f8da..40e5839 100644 --- a/src/Http/Routing/HttpRouter.php +++ b/src/Http/Routing/HttpRouter.php @@ -82,7 +82,7 @@ class HttpRouter implements Router { if($handler instanceof HttpErrorHandler) $this->errorHandler = $handler; elseif($handler === 'html') - $this->setHTMLErrorHandler(); + $this->setHtmlErrorHandler(); else // plain $this->setPlainErrorHandler(); }