Skip to content

Commit

Permalink
Improve PHPDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
webeweb committed Jul 24, 2023
1 parent f155e38 commit 3f620ce
Show file tree
Hide file tree
Showing 30 changed files with 59 additions and 59 deletions.
8 changes: 4 additions & 4 deletions Assets/AbstractAlert.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
8 changes: 4 additions & 4 deletions Assets/AbstractBadge.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
20 changes: 10 additions & 10 deletions Assets/AbstractButton.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,73 +104,73 @@ 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;
return $this;
}

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function setData(array $data): ButtonInterface {
$this->data = $data;
return $this;
}

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function setDisabled(?bool $disabled): ButtonInterface {
$this->disabled = $disabled;
return $this;
}

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function setOutline(?bool $outline): ButtonInterface {
$this->outline = $outline;
Expand Down
14 changes: 7 additions & 7 deletions Assets/AbstractProgressBar.php
Original file line number Diff line number Diff line change
Expand Up @@ -56,50 +56,50 @@ 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;
return $this;
}

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function setStriped(?bool $striped): ProgressBarInterface {
$this->striped = $striped;
Expand Down
2 changes: 1 addition & 1 deletion DependencyInjection/Configuration.php
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ private function addSummernoteLocales(ArrayNodeDefinition $node, array $plugins)
}

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function getConfigTreeBuilder(): TreeBuilder {

Expand Down
2 changes: 1 addition & 1 deletion DependencyInjection/WBWBootstrapExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class WBWBootstrapExtension extends Extension {
const EXTENSION_ALIAS = "wbw_bootstrap";

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function load(array $configs, ContainerBuilder $container): void {

Expand Down
2 changes: 1 addition & 1 deletion Provider/JavascriptProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class JavascriptProvider implements JavascriptProviderInterface {
const SERVICE_NAME = "wbw.bootstrap.provider.javascript";

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function getJavascripts(): array {

Expand Down
2 changes: 1 addition & 1 deletion Tests/Controller/AbstractControllerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
class AbstractControllerTest extends AbstractTestCase {

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
2 changes: 1 addition & 1 deletion Tests/Controller/ViewsControllerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
class ViewsControllerTest extends AbstractWebTestCase {

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public static function setUpBeforeClass(): void {
parent::setUpBeforeClass();
Expand Down
2 changes: 1 addition & 1 deletion Tests/DependencyInjection/WBWBootstrapExtensionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class WBWBootstrapExtensionTest extends AbstractTestCase {
private $configs;

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
2 changes: 1 addition & 1 deletion Tests/Factory/AlertFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class AlertFactoryTest extends AbstractTestCase {
private $args;

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
2 changes: 1 addition & 1 deletion Tests/Factory/BadgeFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class BadgeFactoryTest extends AbstractTestCase {
private $args;

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
2 changes: 1 addition & 1 deletion Tests/Factory/ButtonFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class ButtonFactoryTest extends AbstractTestCase {
private $args;

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
2 changes: 1 addition & 1 deletion Tests/Factory/ProgressBarFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class ProgressBarFactoryTest extends AbstractTestCase {
private $args;

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
16 changes: 8 additions & 8 deletions Tests/Fixtures/Controller/TestAbstractController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions Tests/Fixtures/app/TestKernel.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
class TestKernel extends AbstractKernel {

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function registerBundles(): array {

Expand All @@ -37,7 +37,7 @@ public function registerBundles(): array {
}

/**
* {@inheritdoc}
* {@inheritDoc}
*/
public function registerContainerConfiguration(LoaderInterface $loader): void {

Expand Down
2 changes: 1 addition & 1 deletion Tests/Renderer/Assets/AlertRendererTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class AlertRendererTest extends AbstractTestCase {
private $alert;

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
2 changes: 1 addition & 1 deletion Tests/Renderer/Assets/BadgeRendererTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class BadgeRendererTest extends AbstractTestCase {
private $badge;

/**
* {@inheritdoc}
* {@inheritDoc}
*/
protected function setUp(): void {
parent::setUp();
Expand Down
Loading

0 comments on commit 3f620ce

Please sign in to comment.