From 3f620cee97db0ca7b7b1718ec62d4539400c2321 Mon Sep 17 00:00:00 2001 From: webeweb Date: Mon, 24 Jul 2023 12:40:15 +0200 Subject: [PATCH] Improve PHPDoc --- Assets/AbstractAlert.php | 8 ++++---- Assets/AbstractBadge.php | 8 ++++---- Assets/AbstractButton.php | 20 +++++++++---------- Assets/AbstractProgressBar.php | 14 ++++++------- DependencyInjection/Configuration.php | 2 +- DependencyInjection/WBWBootstrapExtension.php | 2 +- Provider/JavascriptProvider.php | 2 +- Tests/Controller/AbstractControllerTest.php | 2 +- Tests/Controller/ViewsControllerTest.php | 2 +- .../WBWBootstrapExtensionTest.php | 2 +- Tests/Factory/AlertFactoryTest.php | 2 +- Tests/Factory/BadgeFactoryTest.php | 2 +- Tests/Factory/ButtonFactoryTest.php | 2 +- Tests/Factory/ProgressBarFactoryTest.php | 2 +- .../Controller/TestAbstractController.php | 16 +++++++-------- Tests/Fixtures/app/TestKernel.php | 4 ++-- Tests/Renderer/Assets/AlertRendererTest.php | 2 +- Tests/Renderer/Assets/BadgeRendererTest.php | 2 +- Tests/Renderer/Assets/ButtonRendererTest.php | 2 +- .../Assets/ProgressBarRendererTest.php | 2 +- .../Component/BreadcrumbTwigExtensionTest.php | 2 +- .../ButtonGroupTwigExtensionTest.php | 2 +- .../Component/NavTwigExtensionTest.php | 2 +- .../Utility/FormButtonTwigExtensionTest.php | 2 +- .../Utility/RoleLabelTwigExtensionTest.php | 2 +- .../Utility/TableButtonTwigExtensionTest.php | 2 +- Twig/Extension/AssetsTwigExtension.php | 2 +- .../Component/GlyphiconTwigExtension.php | 2 +- .../Extension/Component/IconTwigExtension.php | 2 +- WBWBootstrapBundle.php | 2 +- 30 files changed, 59 insertions(+), 59 deletions(-) diff --git a/Assets/AbstractAlert.php b/Assets/AbstractAlert.php index bf842176..509737e8 100644 --- a/Assets/AbstractAlert.php +++ b/Assets/AbstractAlert.php @@ -59,28 +59,28 @@ public static function enumTypes(): array { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getDismissible(): ?bool { return $this->dismissible; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getPrefix(): ?string { return "alert-"; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function jsonSerialize(): array { return JsonSerializer::serializeAlert($this); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setDismissible(?bool $dismissible): AlertInterface { $this->dismissible = $dismissible; diff --git a/Assets/AbstractBadge.php b/Assets/AbstractBadge.php index 25c45fed..6588a92c 100644 --- a/Assets/AbstractBadge.php +++ b/Assets/AbstractBadge.php @@ -59,28 +59,28 @@ public static function enumTypes(): array { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getPill(): ?bool { return $this->pill; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getPrefix(): ?string { return "badge-"; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function jsonSerialize(): array { return JsonSerializer::serializeBadge($this); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setPill(?bool $pill): BadgeInterface { $this->pill = $pill; diff --git a/Assets/AbstractButton.php b/Assets/AbstractButton.php index 1ec18770..c4d9c883 100644 --- a/Assets/AbstractButton.php +++ b/Assets/AbstractButton.php @@ -104,49 +104,49 @@ public static function enumTypes(): array { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getBlock(): ?bool { return $this->block; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getData(): array { return $this->data; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getDisabled(): ?bool { return $this->disabled; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getOutline(): ?bool { return $this->outline; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getPrefix(): ?string { return "btn-"; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function jsonSerialize(): array { return JsonSerializer::serializeButton($this); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setBlock(?bool $block): ButtonInterface { $this->block = $block; @@ -154,7 +154,7 @@ public function setBlock(?bool $block): ButtonInterface { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setData(array $data): ButtonInterface { $this->data = $data; @@ -162,7 +162,7 @@ public function setData(array $data): ButtonInterface { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setDisabled(?bool $disabled): ButtonInterface { $this->disabled = $disabled; @@ -170,7 +170,7 @@ public function setDisabled(?bool $disabled): ButtonInterface { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setOutline(?bool $outline): ButtonInterface { $this->outline = $outline; diff --git a/Assets/AbstractProgressBar.php b/Assets/AbstractProgressBar.php index 8e46e5df..f32d69c7 100644 --- a/Assets/AbstractProgressBar.php +++ b/Assets/AbstractProgressBar.php @@ -56,42 +56,42 @@ public function __construct(?string $type) { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getAnimated(): ?bool { return $this->animated; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getPrefix(): ?string { return "progress-bar-"; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getStriped(): ?bool { return $this->striped; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getType(): ?string { return $this->type; } /** - * {@inheritdoc} + * {@inheritDoc} */ public function jsonSerialize(): array { return JsonSerializer::serializeProgressBar($this); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setAnimated(?bool $animated): ProgressBarInterface { $this->animated = $animated; @@ -99,7 +99,7 @@ public function setAnimated(?bool $animated): ProgressBarInterface { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function setStriped(?bool $striped): ProgressBarInterface { $this->striped = $striped; diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php index 0973f8ad..c84dda2d 100644 --- a/DependencyInjection/Configuration.php +++ b/DependencyInjection/Configuration.php @@ -125,7 +125,7 @@ private function addSummernoteLocales(ArrayNodeDefinition $node, array $plugins) } /** - * {@inheritdoc} + * {@inheritDoc} */ public function getConfigTreeBuilder(): TreeBuilder { diff --git a/DependencyInjection/WBWBootstrapExtension.php b/DependencyInjection/WBWBootstrapExtension.php index 068e3d27..f1a183c9 100644 --- a/DependencyInjection/WBWBootstrapExtension.php +++ b/DependencyInjection/WBWBootstrapExtension.php @@ -34,7 +34,7 @@ class WBWBootstrapExtension extends Extension { const EXTENSION_ALIAS = "wbw_bootstrap"; /** - * {@inheritdoc} + * {@inheritDoc} */ public function load(array $configs, ContainerBuilder $container): void { diff --git a/Provider/JavascriptProvider.php b/Provider/JavascriptProvider.php index 8b41458f..2d33e6f4 100644 --- a/Provider/JavascriptProvider.php +++ b/Provider/JavascriptProvider.php @@ -29,7 +29,7 @@ class JavascriptProvider implements JavascriptProviderInterface { const SERVICE_NAME = "wbw.bootstrap.provider.javascript"; /** - * {@inheritdoc} + * {@inheritDoc} */ public function getJavascripts(): array { diff --git a/Tests/Controller/AbstractControllerTest.php b/Tests/Controller/AbstractControllerTest.php index d1427e39..457268b2 100644 --- a/Tests/Controller/AbstractControllerTest.php +++ b/Tests/Controller/AbstractControllerTest.php @@ -27,7 +27,7 @@ class AbstractControllerTest extends AbstractTestCase { /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Controller/ViewsControllerTest.php b/Tests/Controller/ViewsControllerTest.php index ed7d7246..e7f93388 100644 --- a/Tests/Controller/ViewsControllerTest.php +++ b/Tests/Controller/ViewsControllerTest.php @@ -25,7 +25,7 @@ class ViewsControllerTest extends AbstractWebTestCase { /** - * {@inheritdoc} + * {@inheritDoc} */ public static function setUpBeforeClass(): void { parent::setUpBeforeClass(); diff --git a/Tests/DependencyInjection/WBWBootstrapExtensionTest.php b/Tests/DependencyInjection/WBWBootstrapExtensionTest.php index 3ff7b0f9..167f7b14 100644 --- a/Tests/DependencyInjection/WBWBootstrapExtensionTest.php +++ b/Tests/DependencyInjection/WBWBootstrapExtensionTest.php @@ -51,7 +51,7 @@ class WBWBootstrapExtensionTest extends AbstractTestCase { private $configs; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Factory/AlertFactoryTest.php b/Tests/Factory/AlertFactoryTest.php index acdd0c76..e72570fb 100644 --- a/Tests/Factory/AlertFactoryTest.php +++ b/Tests/Factory/AlertFactoryTest.php @@ -40,7 +40,7 @@ class AlertFactoryTest extends AbstractTestCase { private $args; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Factory/BadgeFactoryTest.php b/Tests/Factory/BadgeFactoryTest.php index 004f53f3..6ec2d7f3 100644 --- a/Tests/Factory/BadgeFactoryTest.php +++ b/Tests/Factory/BadgeFactoryTest.php @@ -41,7 +41,7 @@ class BadgeFactoryTest extends AbstractTestCase { private $args; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Factory/ButtonFactoryTest.php b/Tests/Factory/ButtonFactoryTest.php index 13499763..7ef49d0d 100644 --- a/Tests/Factory/ButtonFactoryTest.php +++ b/Tests/Factory/ButtonFactoryTest.php @@ -42,7 +42,7 @@ class ButtonFactoryTest extends AbstractTestCase { private $args; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Factory/ProgressBarFactoryTest.php b/Tests/Factory/ProgressBarFactoryTest.php index d5656326..de804a8f 100644 --- a/Tests/Factory/ProgressBarFactoryTest.php +++ b/Tests/Factory/ProgressBarFactoryTest.php @@ -36,7 +36,7 @@ class ProgressBarFactoryTest extends AbstractTestCase { private $args; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Fixtures/Controller/TestAbstractController.php b/Tests/Fixtures/Controller/TestAbstractController.php index 981c1552..266c8162 100644 --- a/Tests/Fixtures/Controller/TestAbstractController.php +++ b/Tests/Fixtures/Controller/TestAbstractController.php @@ -24,56 +24,56 @@ class TestAbstractController extends AbstractController { /** - * {@inheritdoc} + * {@inheritDoc} */ public function notifyDanger(string $content): NotificationEvent { return parent::notifyDanger($content); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function notifyInfo(string $content): NotificationEvent { return parent::notifyInfo($content); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function notifySuccess(string $content): NotificationEvent { return parent::notifySuccess($content); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function notifyWarning(string $content): NotificationEvent { return parent::notifyWarning($content); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function toastDanger(string $content): ToastEvent { return parent::toastDanger($content); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function toastInfo(string $content): ToastEvent { return parent::toastInfo($content); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function toastSuccess(string $content): ToastEvent { return parent::toastSuccess($content); } /** - * {@inheritdoc} + * {@inheritDoc} */ public function toastWarning(string $content): ToastEvent { return parent::toastWarning($content); diff --git a/Tests/Fixtures/app/TestKernel.php b/Tests/Fixtures/app/TestKernel.php index 52d16d44..63eb0316 100644 --- a/Tests/Fixtures/app/TestKernel.php +++ b/Tests/Fixtures/app/TestKernel.php @@ -21,7 +21,7 @@ class TestKernel extends AbstractKernel { /** - * {@inheritdoc} + * {@inheritDoc} */ public function registerBundles(): array { @@ -37,7 +37,7 @@ public function registerBundles(): array { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function registerContainerConfiguration(LoaderInterface $loader): void { diff --git a/Tests/Renderer/Assets/AlertRendererTest.php b/Tests/Renderer/Assets/AlertRendererTest.php index 3d0da3e9..46054ed6 100644 --- a/Tests/Renderer/Assets/AlertRendererTest.php +++ b/Tests/Renderer/Assets/AlertRendererTest.php @@ -32,7 +32,7 @@ class AlertRendererTest extends AbstractTestCase { private $alert; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Renderer/Assets/BadgeRendererTest.php b/Tests/Renderer/Assets/BadgeRendererTest.php index 56c32de5..f5457f60 100644 --- a/Tests/Renderer/Assets/BadgeRendererTest.php +++ b/Tests/Renderer/Assets/BadgeRendererTest.php @@ -32,7 +32,7 @@ class BadgeRendererTest extends AbstractTestCase { private $badge; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Renderer/Assets/ButtonRendererTest.php b/Tests/Renderer/Assets/ButtonRendererTest.php index 2490e90f..7a62650a 100644 --- a/Tests/Renderer/Assets/ButtonRendererTest.php +++ b/Tests/Renderer/Assets/ButtonRendererTest.php @@ -32,7 +32,7 @@ class ButtonRendererTest extends AbstractTestCase { private $button; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Renderer/Assets/ProgressBarRendererTest.php b/Tests/Renderer/Assets/ProgressBarRendererTest.php index a1aad372..0feea977 100644 --- a/Tests/Renderer/Assets/ProgressBarRendererTest.php +++ b/Tests/Renderer/Assets/ProgressBarRendererTest.php @@ -32,7 +32,7 @@ class ProgressBarRendererTest extends AbstractTestCase { private $progressBar; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Twig/Extension/Component/BreadcrumbTwigExtensionTest.php b/Tests/Twig/Extension/Component/BreadcrumbTwigExtensionTest.php index cb25ba82..5d8994c1 100644 --- a/Tests/Twig/Extension/Component/BreadcrumbTwigExtensionTest.php +++ b/Tests/Twig/Extension/Component/BreadcrumbTwigExtensionTest.php @@ -36,7 +36,7 @@ class BreadcrumbTwigExtensionTest extends AbstractTestCase { private $tree; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Twig/Extension/Component/ButtonGroupTwigExtensionTest.php b/Tests/Twig/Extension/Component/ButtonGroupTwigExtensionTest.php index 28d6e59e..33affd24 100644 --- a/Tests/Twig/Extension/Component/ButtonGroupTwigExtensionTest.php +++ b/Tests/Twig/Extension/Component/ButtonGroupTwigExtensionTest.php @@ -41,7 +41,7 @@ class ButtonGroupTwigExtensionTest extends AbstractTestCase { private $editButton; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Twig/Extension/Component/NavTwigExtensionTest.php b/Tests/Twig/Extension/Component/NavTwigExtensionTest.php index 4270d0e7..cfda516a 100644 --- a/Tests/Twig/Extension/Component/NavTwigExtensionTest.php +++ b/Tests/Twig/Extension/Component/NavTwigExtensionTest.php @@ -33,7 +33,7 @@ class NavTwigExtensionTest extends AbstractTestCase { private $items; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Twig/Extension/Utility/FormButtonTwigExtensionTest.php b/Tests/Twig/Extension/Utility/FormButtonTwigExtensionTest.php index 452a1303..82a7ed1a 100644 --- a/Tests/Twig/Extension/Utility/FormButtonTwigExtensionTest.php +++ b/Tests/Twig/Extension/Utility/FormButtonTwigExtensionTest.php @@ -34,7 +34,7 @@ class FormButtonTwigExtensionTest extends AbstractTestCase { private $buttonTwigExtension; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Twig/Extension/Utility/RoleLabelTwigExtensionTest.php b/Tests/Twig/Extension/Utility/RoleLabelTwigExtensionTest.php index 063718a8..346421f8 100644 --- a/Tests/Twig/Extension/Utility/RoleLabelTwigExtensionTest.php +++ b/Tests/Twig/Extension/Utility/RoleLabelTwigExtensionTest.php @@ -49,7 +49,7 @@ class RoleLabelTwigExtensionTest extends AbstractTestCase { private $transChoices; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Tests/Twig/Extension/Utility/TableButtonTwigExtensionTest.php b/Tests/Twig/Extension/Utility/TableButtonTwigExtensionTest.php index 2170cc2f..d7cc8189 100644 --- a/Tests/Twig/Extension/Utility/TableButtonTwigExtensionTest.php +++ b/Tests/Twig/Extension/Utility/TableButtonTwigExtensionTest.php @@ -34,7 +34,7 @@ class TableButtonTwigExtensionTest extends AbstractTestCase { private $buttonTwigExtension; /** - * {@inheritdoc} + * {@inheritDoc} */ protected function setUp(): void { parent::setUp(); diff --git a/Twig/Extension/AssetsTwigExtension.php b/Twig/Extension/AssetsTwigExtension.php index 00820a88..bb7f2465 100644 --- a/Twig/Extension/AssetsTwigExtension.php +++ b/Twig/Extension/AssetsTwigExtension.php @@ -67,7 +67,7 @@ public function getFunctions(): array { } /** - * {@inheritdoc} + * {@inheritDoc} */ public static function renderIcon(Environment $twigEnvironment, ?string $name, string $style = null): ?string { diff --git a/Twig/Extension/Component/GlyphiconTwigExtension.php b/Twig/Extension/Component/GlyphiconTwigExtension.php index 725fc8f9..f19f5159 100644 --- a/Twig/Extension/Component/GlyphiconTwigExtension.php +++ b/Twig/Extension/Component/GlyphiconTwigExtension.php @@ -69,7 +69,7 @@ protected function getFunctions3(): array { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function renderIcon(?string $name, ?string $style): string { return $this->bootstrapGlyphiconFunction(["name" => $name, "style" => $style]); diff --git a/Twig/Extension/Component/IconTwigExtension.php b/Twig/Extension/Component/IconTwigExtension.php index 0e8d8021..75f7cad2 100644 --- a/Twig/Extension/Component/IconTwigExtension.php +++ b/Twig/Extension/Component/IconTwigExtension.php @@ -54,7 +54,7 @@ public function getFunctions(): array { } /** - * {@inheritdoc} + * {@inheritDoc} */ public function renderIcon(?string $name, ?string $style): string { return $this->bootstrapIconFunction(["name" => $name, "style" => $style]); diff --git a/WBWBootstrapBundle.php b/WBWBootstrapBundle.php index dff89524..a1759f69 100644 --- a/WBWBootstrapBundle.php +++ b/WBWBootstrapBundle.php @@ -114,7 +114,7 @@ class WBWBootstrapBundle extends Bundle implements AssetsProviderInterface { const TRANSLATION_DOMAIN = "WBWBootstrapBundle"; /** - * {@inheritdoc} + * {@inheritDoc} */ public function getAssetsRelativeDirectory(): string { return self::ASSETS_RELATIVE_DIRECTORY;