Update formatting

lkrms · lkrms · commit ade8f9f975e8 · 2024-08-08T16:54:17.000+10:00
diff --git a/src/Toolkit/Cache/CacheStore.php b/src/Toolkit/Cache/CacheStore.php
@@ -50,7 +50,9 @@ public function __construct(string $filename = ':memory:')
         );
     }
 
-    /** @internal */
+    /**
+     * @internal
+     */
     protected function __clone() {}
 
     /**
diff --git a/src/Toolkit/Cli/CliCommand.php b/src/Toolkit/Cli/CliCommand.php
@@ -27,8 +27,11 @@
  */
 abstract class CliCommand implements CliCommandInterface
 {
-    /** @api */
+    /**
+     * @api
+     */
     protected CliApplicationInterface $App;
+
     /** @var string[] */
     private array $Name = [];
     /** @var array<string,CliOption>|null */
diff --git a/src/Toolkit/Contract/Collection/CollectionInterface.php b/src/Toolkit/Contract/Collection/CollectionInterface.php
@@ -55,7 +55,9 @@ interface CollectionInterface extends
      */
     public const FIND_KEY = 8;
 
-    /** @param Arrayable<TKey,TValue>|iterable<TKey,TValue> $items */
+    /**
+     * @param Arrayable<TKey,TValue>|iterable<TKey,TValue> $items
+     */
     public function __construct($items = []);
 
     /**
diff --git a/src/Toolkit/Contract/Container/ArgumentsNotUsedExceptionInterface.php b/src/Toolkit/Contract/Container/ArgumentsNotUsedExceptionInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Container;
 
-/** @api */
+/**
+ * @api
+ */
 interface ArgumentsNotUsedExceptionInterface extends ContainerExceptionInterface {}
diff --git a/src/Toolkit/Contract/Container/ContainerExceptionInterface.php b/src/Toolkit/Contract/Container/ContainerExceptionInterface.php
@@ -4,5 +4,7 @@
 
 use Psr\Container\ContainerExceptionInterface as PsrContainerExceptionInterface;
 
-/** @api */
+/**
+ * @api
+ */
 interface ContainerExceptionInterface extends PsrContainerExceptionInterface {}
diff --git a/src/Toolkit/Contract/Container/InvalidServiceExceptionInterface.php b/src/Toolkit/Contract/Container/InvalidServiceExceptionInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Container;
 
-/** @api */
+/**
+ * @api
+ */
 interface InvalidServiceExceptionInterface extends ContainerExceptionInterface {}
diff --git a/src/Toolkit/Contract/Container/ServiceNotFoundExceptionInterface.php b/src/Toolkit/Contract/Container/ServiceNotFoundExceptionInterface.php
@@ -4,5 +4,7 @@
 
 use Psr\Container\NotFoundExceptionInterface;
 
-/** @api */
+/**
+ * @api
+ */
 interface ServiceNotFoundExceptionInterface extends ContainerExceptionInterface, NotFoundExceptionInterface {}
diff --git a/src/Toolkit/Contract/Core/Immutable.php b/src/Toolkit/Contract/Core/Immutable.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Core;
 
-/** @api */
+/**
+ * @api
+ */
 interface Immutable {}
diff --git a/src/Toolkit/Contract/Core/ProviderContextInterface.php b/src/Toolkit/Contract/Core/ProviderContextInterface.php
@@ -77,7 +77,9 @@ public function withParent(?Treeable $parent);
      */
     public function withConformity($conformity);
 
-    /** @return TProvider */
+    /**
+     * @return TProvider
+     */
     public function getProvider(): ProviderInterface;
 
     /**
diff --git a/src/Toolkit/Contract/Http/HttpHeadersInterface.php b/src/Toolkit/Contract/Http/HttpHeadersInterface.php
@@ -17,7 +17,9 @@ interface HttpHeadersInterface extends
     Immutable,
     Stringable
 {
-    /** @param Arrayable<string,string[]|string>|iterable<string,string[]|string> $items */
+    /**
+     * @param Arrayable<string,string[]|string>|iterable<string,string[]|string> $items
+     */
     public function __construct($items = []);
 
     /**
diff --git a/src/Toolkit/Contract/Http/HttpRequestInterface.php b/src/Toolkit/Contract/Http/HttpRequestInterface.php
@@ -4,5 +4,7 @@
 
 use Psr\Http\Message\RequestInterface;
 
-/** @api */
+/**
+ * @api
+ */
 interface HttpRequestInterface extends HttpMessageInterface, RequestInterface {}
diff --git a/src/Toolkit/Contract/Http/HttpResponseInterface.php b/src/Toolkit/Contract/Http/HttpResponseInterface.php
@@ -4,5 +4,7 @@
 
 use Psr\Http\Message\ResponseInterface;
 
-/** @api */
+/**
+ * @api
+ */
 interface HttpResponseInterface extends HttpMessageInterface, ResponseInterface {}
diff --git a/src/Toolkit/Contract/Http/HttpServerRequestInterface.php b/src/Toolkit/Contract/Http/HttpServerRequestInterface.php
@@ -4,5 +4,7 @@
 
 use Psr\Http\Message\ServerRequestInterface;
 
-/** @api */
+/**
+ * @api
+ */
 interface HttpServerRequestInterface extends HttpRequestInterface, ServerRequestInterface {}
diff --git a/src/Toolkit/Contract/Sync/Event/SyncStoreLoadedEventInterface.php b/src/Toolkit/Contract/Sync/Event/SyncStoreLoadedEventInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Sync\Event;
 
-/** @api */
+/**
+ * @api
+ */
 interface SyncStoreLoadedEventInterface extends SyncStoreEventInterface {}
diff --git a/src/Toolkit/Contract/Sync/Exception/FilterPolicyViolationExceptionInterface.php b/src/Toolkit/Contract/Sync/Exception/FilterPolicyViolationExceptionInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Sync\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 interface FilterPolicyViolationExceptionInterface extends SyncExceptionInterface {}
diff --git a/src/Toolkit/Contract/Sync/Exception/InvalidFilterExceptionInterface.php b/src/Toolkit/Contract/Sync/Exception/InvalidFilterExceptionInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Sync\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 interface InvalidFilterExceptionInterface extends SyncExceptionInterface {}
diff --git a/src/Toolkit/Contract/Sync/Exception/InvalidFilterSignatureExceptionInterface.php b/src/Toolkit/Contract/Sync/Exception/InvalidFilterSignatureExceptionInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Sync\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 interface InvalidFilterSignatureExceptionInterface extends InvalidFilterExceptionInterface {}
diff --git a/src/Toolkit/Contract/Sync/Exception/SyncEntityNotFoundExceptionInterface.php b/src/Toolkit/Contract/Sync/Exception/SyncEntityNotFoundExceptionInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Sync\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 interface SyncEntityNotFoundExceptionInterface extends SyncExceptionInterface {}
diff --git a/src/Toolkit/Contract/Sync/Exception/SyncEntityRecursionExceptionInterface.php b/src/Toolkit/Contract/Sync/Exception/SyncEntityRecursionExceptionInterface.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Contract\Sync\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 interface SyncEntityRecursionExceptionInterface extends SyncExceptionInterface {}
diff --git a/src/Toolkit/Contract/Sync/Exception/SyncExceptionInterface.php b/src/Toolkit/Contract/Sync/Exception/SyncExceptionInterface.php
@@ -4,5 +4,7 @@
 
 use Throwable;
 
-/** @api */
+/**
+ * @api
+ */
 interface SyncExceptionInterface extends Throwable {}
diff --git a/src/Toolkit/Contract/Sync/SyncErrorCollectionInterface.php b/src/Toolkit/Contract/Sync/SyncErrorCollectionInterface.php
@@ -52,6 +52,8 @@ public function reportErrors(
         string $successText = 'No sync errors recorded'
     ): void;
 
-    /** @return array<array{code:string,title:string,detail:string,meta:array{level:string,count:int,seen:int,values:list<mixed[]|object|int|float|string|bool|null>}}> */
+    /**
+     * @return array<array{code:string,title:string,detail:string,meta:array{level:string,count:int,seen:int,values:list<mixed[]|object|int|float|string|bool|null>}}>
+     */
     public function jsonSerialize(): array;
 }
diff --git a/src/Toolkit/Contract/stubs/Stringable.php b/src/Toolkit/Contract/stubs/Stringable.php
@@ -3,7 +3,9 @@
 if (\PHP_VERSION_ID < 80000 && !interface_exists('Stringable', false)) {
     interface Stringable
     {
-        /** @return string */
+        /**
+         * @return string
+         */
         public function __toString();
     }
 }
diff --git a/src/Toolkit/Core/Concern/HasUnderlyingService.php b/src/Toolkit/Core/Concern/HasUnderlyingService.php
@@ -20,7 +20,9 @@ trait HasUnderlyingService
     /** @var array<class-string<static>,true> */
     private static array $LoadedServices = [];
 
-    /** @return class-string<TService>|array<class-string<TService>,class-string<TService>|array<class-string<TService>>> */
+    /**
+     * @return class-string<TService>|array<class-string<TService>,class-string<TService>|array<class-string<TService>>>
+     */
     abstract protected static function getService();
 
     /**
diff --git a/src/Toolkit/Core/Exception/InvalidConfigurationException.php b/src/Toolkit/Core/Exception/InvalidConfigurationException.php
@@ -4,5 +4,7 @@
 
 use Salient\Core\AbstractException;
 
-/** @api */
+/**
+ * @api
+ */
 class InvalidConfigurationException extends AbstractException {}
diff --git a/src/Toolkit/Core/Exception/ProcessException.php b/src/Toolkit/Core/Exception/ProcessException.php
@@ -4,5 +4,7 @@
 
 use Salient\Core\AbstractException;
 
-/** @api */
+/**
+ * @api
+ */
 class ProcessException extends AbstractException {}
diff --git a/src/Toolkit/Core/Exception/ProcessFailedException.php b/src/Toolkit/Core/Exception/ProcessFailedException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Core\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class ProcessFailedException extends ProcessException {}
diff --git a/src/Toolkit/Core/Exception/ProcessTerminatedBySignalException.php b/src/Toolkit/Core/Exception/ProcessTerminatedBySignalException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Core\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class ProcessTerminatedBySignalException extends ProcessException {}
diff --git a/src/Toolkit/Core/Exception/ProcessTimedOutException.php b/src/Toolkit/Core/Exception/ProcessTimedOutException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Core\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class ProcessTimedOutException extends ProcessException {}
diff --git a/src/Toolkit/Polyfill/stubs/Stringable.php b/src/Toolkit/Polyfill/stubs/Stringable.php
@@ -3,7 +3,9 @@
 if (\PHP_VERSION_ID < 80000 && !interface_exists('Stringable', false)) {
     interface Stringable
     {
-        /** @return string */
+        /**
+         * @return string
+         */
         public function __toString();
     }
 }
diff --git a/src/Toolkit/Sync/Event/AbstractSyncEvent.php b/src/Toolkit/Sync/Event/AbstractSyncEvent.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Sync\Event;
 
-/** @internal */
+/**
+ * @internal
+ */
 abstract class AbstractSyncEvent {}
diff --git a/src/Toolkit/Sync/Event/SyncStoreLoadedEvent.php b/src/Toolkit/Sync/Event/SyncStoreLoadedEvent.php
@@ -4,5 +4,7 @@
 
 use Salient\Contract\Sync\Event\SyncStoreLoadedEventInterface;
 
-/** @internal */
+/**
+ * @internal
+ */
 class SyncStoreLoadedEvent extends AbstractSyncStoreEvent implements SyncStoreLoadedEventInterface {}
diff --git a/src/Toolkit/Sync/Exception/AbstractSyncException.php b/src/Toolkit/Sync/Exception/AbstractSyncException.php
@@ -5,5 +5,7 @@
 use Salient\Contract\Sync\Exception\SyncExceptionInterface;
 use Salient\Core\AbstractException;
 
-/** @internal */
+/**
+ * @internal
+ */
 abstract class AbstractSyncException extends AbstractException implements SyncExceptionInterface {}
diff --git a/src/Toolkit/Utility/Exception/FilesystemErrorException.php b/src/Toolkit/Utility/Exception/FilesystemErrorException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Utility\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class FilesystemErrorException extends AbstractUtilityException {}
diff --git a/src/Toolkit/Utility/Exception/InvalidEnvFileSyntaxException.php b/src/Toolkit/Utility/Exception/InvalidEnvFileSyntaxException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Utility\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class InvalidEnvFileSyntaxException extends AbstractUtilityException {}
diff --git a/src/Toolkit/Utility/Exception/InvalidEnvironmentException.php b/src/Toolkit/Utility/Exception/InvalidEnvironmentException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Utility\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class InvalidEnvironmentException extends AbstractUtilityException {}
diff --git a/src/Toolkit/Utility/Exception/InvalidRuntimeConfigurationException.php b/src/Toolkit/Utility/Exception/InvalidRuntimeConfigurationException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Utility\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class InvalidRuntimeConfigurationException extends AbstractUtilityException {}
diff --git a/src/Toolkit/Utility/Exception/UncloneableObjectException.php b/src/Toolkit/Utility/Exception/UncloneableObjectException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Utility\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class UncloneableObjectException extends AbstractUtilityException {}
diff --git a/src/Toolkit/Utility/Exception/UnreadDataException.php b/src/Toolkit/Utility/Exception/UnreadDataException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Utility\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class UnreadDataException extends FilesystemErrorException {}
diff --git a/src/Toolkit/Utility/Exception/UnwrittenDataException.php b/src/Toolkit/Utility/Exception/UnwrittenDataException.php
@@ -2,5 +2,7 @@
 
 namespace Salient\Utility\Exception;
 
-/** @api */
+/**
+ * @api
+ */
 class UnwrittenDataException extends FilesystemErrorException {}
diff --git a/src/Toolkit/Utility/stubs/Stringable.php b/src/Toolkit/Utility/stubs/Stringable.php
@@ -3,7 +3,9 @@
 if (\PHP_VERSION_ID < 80000 && !interface_exists('Stringable', false)) {
     interface Stringable
     {
-        /** @return string */
+        /**
+         * @return string
+         */
         public function __toString();
     }
 }
diff --git a/tests/stubs/ADOConnection.stub b/tests/stubs/ADOConnection.stub
@@ -78,7 +78,9 @@ abstract class ADOConnection
      */
     public function GetOne($sql, $inputarr = false) {}
 
-    /** @return mixed */
+    /**
+     * @return mixed
+     */
     public function Close() {}
 
     /**
diff --git a/tests/stubs/UnitEnum.php b/tests/stubs/UnitEnum.php

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,9 @@ public function __construct(string $filename = ':memory:')`
`50`	`50`	`);`
`51`	`51`	`}`
`52`	`52`
`53`		`- /** @internal */`
	`53`	`+ /**`
	`54`	`+ * @internal`
	`55`	`+ */`
`54`	`56`	`protected function __clone() {}`
`55`	`57`
`56`	`58`	`/**`